/
OverlayTrigger.tsx
344 lines (292 loc) · 8.44 KB
/
OverlayTrigger.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
import contains from 'dom-helpers/contains';
import PropTypes from 'prop-types';
import React, { cloneElement, useCallback, useRef } from 'react';
import useTimeout from '@restart/hooks/useTimeout';
import safeFindDOMNode from 'react-overlays/safeFindDOMNode';
import warning from 'warning';
import { useUncontrolledProp } from 'uncontrollable';
import { Modifier } from 'react-overlays/esm/usePopper';
import Overlay, { OverlayChildren, OverlayProps } from './Overlay';
export type OverlayTriggerType = 'hover' | 'click' | 'focus';
export type OverlayDelay = number | { show: number; hide: number };
export type OverlayInjectedProps = {
onFocus?: (...args: any[]) => any;
};
export interface OverlayTriggerProps
extends Omit<OverlayProps, 'children' | 'target'> {
children: React.ReactElement;
trigger?: OverlayTriggerType | OverlayTriggerType[];
delay?: OverlayDelay;
show?: boolean;
defaultShow?: boolean;
onToggle?: (nextShow: boolean) => void;
flip?: boolean;
overlay: OverlayChildren;
target?: never;
onHide?: never;
}
class RefHolder extends React.Component {
render() {
return this.props.children;
}
}
function normalizeDelay(delay?: OverlayDelay) {
return delay && typeof delay === 'object'
? delay
: {
show: delay,
hide: delay,
};
}
// Simple implementation of mouseEnter and mouseLeave.
// React's built version is broken: https://github.com/facebook/react/issues/4251
// for cases when the trigger is disabled and mouseOut/Over can cause flicker
// moving from one child element to another.
function handleMouseOverOut(
handler: (...args: any[]) => any,
args: [React.MouseEvent, ...any[]],
relatedNative,
) {
const [e] = args;
const target = e.currentTarget;
const related = e.relatedTarget || e.nativeEvent[relatedNative];
if ((!related || related !== target) && !contains(target, related)) {
handler(...args);
}
}
const triggerType = PropTypes.oneOf(['click', 'hover', 'focus']);
const propTypes = {
children: PropTypes.element.isRequired,
/**
* Specify which action or actions trigger Overlay visibility
*
* @type {'hover' | 'click' |'focus' | Array<'hover' | 'click' |'focus'>}
*/
trigger: PropTypes.oneOfType([triggerType, PropTypes.arrayOf(triggerType)]),
/**
* A millisecond delay amount to show and hide the Overlay once triggered
*/
delay: PropTypes.oneOfType([
PropTypes.number,
PropTypes.shape({
show: PropTypes.number,
hide: PropTypes.number,
}),
]),
/**
* The visibility of the Overlay. `show` is a _controlled_ prop so should be paired
* with `onToggle` to avoid breaking user interactions.
*
* Manually toggling `show` does **not** wait for `delay` to change the visibility.
*
* @controllable onToggle
*/
show: PropTypes.bool,
/**
* The initial visibility state of the Overlay.
*/
defaultShow: PropTypes.bool,
/**
* A callback that fires when the user triggers a change in tooltip visibility.
*
* `onToggle` is called with the desired next `show`, and generally should be passed
* back to the `show` prop. `onToggle` fires _after_ the configured `delay`
*
* @controllable `show`
*/
onToggle: PropTypes.func,
/**
The initial flip state of the Overlay.
*/
flip: PropTypes.bool,
/**
* An element or text to overlay next to the target.
*/
overlay: PropTypes.oneOfType([PropTypes.func, PropTypes.element.isRequired]),
/**
* A Popper.js config object passed to the the underlying popper instance.
*/
popperConfig: PropTypes.object,
// Overridden props from `<Overlay>`.
/**
* @private
*/
target: PropTypes.oneOf([null]),
/**
* @private
*/
onHide: PropTypes.oneOf([null]),
/**
* The placement of the Overlay in relation to it's `target`.
*/
placement: PropTypes.oneOf([
'auto-start',
'auto',
'auto-end',
'top-start',
'top',
'top-end',
'right-start',
'right',
'right-end',
'bottom-end',
'bottom',
'bottom-start',
'left-end',
'left',
'left-start',
]),
};
const defaultProps = {
defaultShow: false,
trigger: ['hover', 'focus'],
};
function OverlayTrigger({
trigger,
overlay,
children,
popperConfig = {},
show: propsShow,
defaultShow = false,
onToggle,
delay: propsDelay,
placement,
flip = placement && placement.indexOf('auto') !== -1,
...props
}: OverlayTriggerProps) {
const triggerNodeRef = useRef(null);
const timeout = useTimeout();
const hoverStateRef = useRef<string>('');
const [show, setShow] = useUncontrolledProp(propsShow, defaultShow, onToggle);
const delay = normalizeDelay(propsDelay);
const child = React.Children.only(children);
const { onFocus, onBlur, onClick } = child.props;
const getTarget = useCallback(
() => safeFindDOMNode(triggerNodeRef.current),
[],
);
const handleShow = useCallback(() => {
timeout.clear();
hoverStateRef.current = 'show';
if (!delay.show) {
setShow(true);
return;
}
timeout.set(() => {
if (hoverStateRef.current === 'show') setShow(true);
}, delay.show);
}, [delay.show, setShow, timeout]);
const handleHide = useCallback(() => {
timeout.clear();
hoverStateRef.current = 'hide';
if (!delay.hide) {
setShow(false);
return;
}
timeout.set(() => {
if (hoverStateRef.current === 'hide') setShow(false);
}, delay.hide);
}, [delay.hide, setShow, timeout]);
const handleFocus = useCallback(
(...args: any[]) => {
handleShow();
if (onFocus) onFocus(...args);
},
[handleShow, onFocus],
);
const handleBlur = useCallback(
(...args: any[]) => {
handleHide();
if (onBlur) onBlur(...args);
},
[handleHide, onBlur],
);
const handleClick = useCallback(
(...args: any[]) => {
setShow(!show);
if (onClick) onClick(...args);
},
[onClick, setShow, show],
);
const handleMouseOver = useCallback(
(...args: [React.MouseEvent, ...any[]]) => {
handleMouseOverOut(handleShow, args, 'fromElement');
},
[handleShow],
);
const handleMouseOut = useCallback(
(...args: [React.MouseEvent, ...any[]]) => {
handleMouseOverOut(handleHide, args, 'toElement');
},
[handleHide],
);
// We add aria-describedby in the case where the overlay is a role="tooltip"
// for other cases describedby isn't appropriate (e.g. a popover with inputs) so we don't add it.
const ariaModifier: Modifier<'ariaDescribedBy', {}> = {
name: 'ariaDescribedBy',
enabled: true,
phase: 'afterWrite',
effect: ({ state }) => {
return () => {
if ('removeAttribute' in state.elements.reference)
state.elements.reference.removeAttribute('aria-describedby');
};
},
fn: ({ state }) => {
const { popper, reference } = state.elements;
if (!show || !reference) return;
const role = popper.getAttribute('role') || '';
if (
popper.id &&
role.toLowerCase() === 'tooltip' &&
'setAttribute' in reference
) {
reference.setAttribute('aria-describedby', popper.id);
}
},
};
const triggers: string[] = trigger == null ? [] : [].concat(trigger as any);
const triggerProps: any = {};
if (triggers.indexOf('click') !== -1) {
triggerProps.onClick = handleClick;
}
if (triggers.indexOf('focus') !== -1) {
triggerProps.onFocus = handleFocus;
triggerProps.onBlur = handleBlur;
}
if (triggers.indexOf('hover') !== -1) {
warning(
triggers.length > 1,
'[react-bootstrap] Specifying only the `"hover"` trigger limits the visibility of the overlay to just mouse users. Consider also including the `"focus"` trigger so that touch and keyboard only users can see the overlay as well.',
);
triggerProps.onMouseOver = handleMouseOver;
triggerProps.onMouseOut = handleMouseOut;
}
// TODO: fix typing
// @ts-ignore
const modifiers = [ariaModifier].concat(popperConfig.modifiers || []);
return (
<>
<RefHolder ref={triggerNodeRef}>
{cloneElement(child as any, triggerProps)}
</RefHolder>
<Overlay
{...props}
popperConfig={{
...popperConfig,
modifiers,
}}
show={show}
onHide={handleHide}
target={getTarget as any}
placement={placement}
flip={flip}
>
{overlay}
</Overlay>
</>
);
}
OverlayTrigger.propTypes = propTypes;
OverlayTrigger.defaultProps = defaultProps;
export default OverlayTrigger;