-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
GenericTooltip.tsx
197 lines (172 loc) · 7.18 KB
/
GenericTooltip.tsx
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
import React, {memo, useCallback, useEffect, useImperativeHandle, useRef, useState} from 'react';
import type {LayoutRectangle} from 'react-native';
import {Animated} from 'react-native';
import useLocalize from '@hooks/useLocalize';
import usePrevious from '@hooks/usePrevious';
import useWindowDimensions from '@hooks/useWindowDimensions';
import Log from '@libs/Log';
import StringUtils from '@libs/StringUtils';
import TooltipRefManager from '@libs/TooltipRefManager';
import variables from '@styles/variables';
import CONST from '@src/CONST';
import callOrReturn from '@src/types/utils/callOrReturn';
import BaseGenericTooltip from './BaseGenericTooltip';
import TooltipSense from './TooltipSense';
import type {GenericTooltipProps} from './types';
/**
* The generic tooltip implementation, exposing the tooltip's state
* while leaving the tooltip's target bounds computation to its parent.
*/
function GenericTooltip({
children,
numberOfLines = CONST.TOOLTIP_MAX_LINES,
maxWidth = variables.sideBarWidth,
text = '',
renderTooltipContent,
renderTooltipContentKey = [],
shiftHorizontal = 0,
shiftVertical = 0,
shouldForceRenderingBelow = false,
wrapperStyle = {},
anchorAlignment = {
horizontal: CONST.MODAL.ANCHOR_ORIGIN_HORIZONTAL.CENTER,
vertical: CONST.MODAL.ANCHOR_ORIGIN_VERTICAL.BOTTOM,
},
shouldForceAnimate = false,
shouldUseOverlay: shouldUseOverlayProp = false,
onHideTooltip = () => {},
}: GenericTooltipProps) {
const {preferredLocale} = useLocalize();
const {windowWidth} = useWindowDimensions();
// Is tooltip already rendered on the page's body? happens once.
const [isRendered, setIsRendered] = useState(false);
// Is the tooltip currently visible?
const [isVisible, setIsVisible] = useState(false);
// The distance between the left side of the wrapper view and the left side of the window
const [xOffset, setXOffset] = useState(0);
// The distance between the top of the wrapper view and the top of the window
const [yOffset, setYOffset] = useState(0);
// The width and height of the wrapper view
const [wrapperWidth, setWrapperWidth] = useState(0);
const [wrapperHeight, setWrapperHeight] = useState(0);
// Transparent overlay should disappear once user taps it
const [shouldUseOverlay, setShouldUseOverlay] = useState(shouldUseOverlayProp);
// Whether the tooltip is first tooltip to activate the TooltipSense
const isTooltipSenseInitiator = useRef(false);
const animation = useRef(new Animated.Value(0));
const isAnimationCanceled = useRef(false);
const prevText = usePrevious(text);
useEffect(() => {
if (!renderTooltipContent || !text) {
return;
}
Log.warn('Developer error: Cannot use both text and renderTooltipContent props at the same time in <TooltipRenderedOnPageBody />!');
}, [text, renderTooltipContent]);
/**
* Display the tooltip in an animation.
*/
const showTooltip = useCallback(() => {
setIsRendered(true);
setIsVisible(true);
animation.current.stopAnimation();
// When TooltipSense is active, immediately show the tooltip
if (TooltipSense.isActive() && !shouldForceAnimate) {
animation.current.setValue(1);
} else {
isTooltipSenseInitiator.current = true;
Animated.timing(animation.current, {
toValue: 1,
duration: 140,
delay: 500,
useNativeDriver: false,
}).start(({finished}) => {
isAnimationCanceled.current = !finished;
});
}
TooltipSense.activate();
}, [shouldForceAnimate]);
// eslint-disable-next-line rulesdir/prefer-early-return
useEffect(() => {
// if the tooltip text changed before the initial animation was finished, then the tooltip won't be shown
// we need to show the tooltip again
if (isVisible && isAnimationCanceled.current && text && prevText !== text) {
isAnimationCanceled.current = false;
showTooltip();
}
}, [isVisible, text, prevText, showTooltip]);
/**
* Update the tooltip's target bounding rectangle
*/
const updateTargetBounds = (bounds: LayoutRectangle) => {
if (bounds.width === 0) {
setIsRendered(false);
}
setWrapperWidth(bounds.width);
setWrapperHeight(bounds.height);
setXOffset(bounds.x);
setYOffset(bounds.y);
};
/**
* Hide the tooltip in an animation.
*/
const hideTooltip = useCallback(() => {
animation.current.stopAnimation();
if (TooltipSense.isActive() && !isTooltipSenseInitiator.current) {
animation.current.setValue(0);
} else {
// Hide the first tooltip which initiated the TooltipSense with animation
isTooltipSenseInitiator.current = false;
Animated.timing(animation.current, {
toValue: 0,
duration: 140,
useNativeDriver: false,
}).start();
}
TooltipSense.deactivate();
setIsVisible(false);
}, []);
const onPressOverlay = useCallback(() => {
if (!shouldUseOverlay) {
return;
}
setShouldUseOverlay(false);
hideTooltip();
onHideTooltip();
}, [shouldUseOverlay, onHideTooltip, hideTooltip]);
useImperativeHandle(TooltipRefManager.ref, () => ({hideTooltip}), [hideTooltip]);
// Skip the tooltip and return the children if the text is empty, we don't have a render function.
if (StringUtils.isEmptyString(text) && renderTooltipContent == null) {
return children({isVisible, showTooltip, hideTooltip, updateTargetBounds});
}
return (
<>
{isRendered && (
<BaseGenericTooltip
animation={animation.current}
windowWidth={windowWidth}
xOffset={xOffset}
yOffset={yOffset}
targetWidth={wrapperWidth}
targetHeight={wrapperHeight}
shiftHorizontal={callOrReturn(shiftHorizontal)}
shiftVertical={callOrReturn(shiftVertical)}
text={text}
maxWidth={maxWidth}
numberOfLines={numberOfLines}
renderTooltipContent={renderTooltipContent}
// We pass a key, so whenever the content changes this component will completely remount with a fresh state.
// This prevents flickering/moving while remaining performant.
key={[text, ...renderTooltipContentKey, preferredLocale].join('-')}
shouldForceRenderingBelow={shouldForceRenderingBelow}
wrapperStyle={wrapperStyle}
anchorAlignment={anchorAlignment}
shouldUseOverlay={shouldUseOverlay}
onHideTooltip={onPressOverlay}
/>
)}
{children({isVisible, showTooltip, hideTooltip, updateTargetBounds})}
</>
);
}
GenericTooltip.displayName = 'GenericTooltip';
export default memo(GenericTooltip);