-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
tooltipPropTypes.js
58 lines (45 loc) · 1.97 KB
/
tooltipPropTypes.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import PropTypes from 'prop-types';
import {windowDimensionsPropTypes} from '../withWindowDimensions';
import variables from '../../styles/variables';
import CONST from '../../CONST';
const propTypes = {
/** Enable support for the absolute positioned native(View|Text) children. It will only work for single native child */
absolute: PropTypes.bool,
/** The text to display in the tooltip. */
text: PropTypes.string,
/** Maximum number of lines to show in tooltip */
numberOfLines: PropTypes.number,
/** Styles to be assigned to the Tooltip wrapper views */
containerStyles: PropTypes.arrayOf(PropTypes.object),
/** Children to wrap with Tooltip. */
children: PropTypes.node.isRequired,
/** Props inherited from withWindowDimensions */
...windowDimensionsPropTypes,
/** Any additional amount to manually adjust the horizontal position of the tooltip.
A positive value shifts the tooltip to the right, and a negative value shifts it to the left. */
shiftHorizontal: PropTypes.oneOfType([PropTypes.number, PropTypes.func]),
/** Any additional amount to manually adjust the vertical position of the tooltip.
A positive value shifts the tooltip down, and a negative value shifts it up. */
shiftVertical: PropTypes.oneOfType([PropTypes.number, PropTypes.func]),
/** Number of pixels to set max-width on tooltip */
maxWidth: PropTypes.number,
/** Accessibility prop. Sets the tabindex to 0 if true. Default is true. */
focusable: PropTypes.bool,
/** Render custom content inside the tooltip. Note: This cannot be used together with the text props. */
renderTooltipContent: PropTypes.func,
};
const defaultProps = {
absolute: false,
shiftHorizontal: 0,
shiftVertical: 0,
containerStyles: [],
text: '',
maxWidth: variables.sideBarWidth,
numberOfLines: CONST.TOOLTIP_MAX_LINES,
renderTooltipContent: undefined,
focusable: true,
};
export {
propTypes,
defaultProps,
};