-
-
Notifications
You must be signed in to change notification settings - Fork 226
/
usePopper.js
157 lines (137 loc) · 3.96 KB
/
usePopper.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
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
// @flow strict
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import {
createPopper as defaultCreatePopper,
type Options as PopperOptions,
type VirtualElement,
type State as PopperState,
type Instance as PopperInstance,
} from '@popperjs/core';
import isEqual from 'react-fast-compare';
import { fromEntries, useIsomorphicLayoutEffect } from './utils';
type Options = $Shape<{
...PopperOptions,
createPopper: typeof defaultCreatePopper,
}>;
type Styles = {
[key: string]: $Shape<CSSStyleDeclaration>,
};
type Attributes = {
[key: string]: { [key: string]: string },
};
type State = {
styles: Styles,
attributes: Attributes,
};
const EMPTY_MODIFIERS = [];
type UsePopperResult = $ReadOnly<{
state: ?PopperState,
styles: Styles,
attributes: Attributes,
update: ?$PropertyType<PopperInstance, 'update'>,
forceUpdate: ?$PropertyType<PopperInstance, 'forceUpdate'>,
}>;
export const usePopper = (
referenceElement: ?(Element | VirtualElement),
popperElement: ?HTMLElement,
options: Options = {}
): UsePopperResult => {
const prevOptions = React.useRef<?PopperOptions>(null);
const optionsWithDefaults = {
onFirstUpdate: options.onFirstUpdate,
placement: options.placement || 'bottom',
strategy: options.strategy || 'absolute',
modifiers: options.modifiers || EMPTY_MODIFIERS,
};
const [state, setState] = React.useState<State>({
styles: {
popper: {
position: optionsWithDefaults.strategy,
left: '0',
top: '0',
},
arrow: {
position: 'absolute',
},
},
attributes: {},
});
const updateStateModifier = React.useMemo(
() => ({
name: 'updateState',
enabled: true,
phase: 'write',
fn: ({ state }) => {
const elements = Object.keys(state.elements);
ReactDOM.flushSync(() => {
setState({
styles: fromEntries(
elements.map((element) => [element, state.styles[element] || {}])
),
attributes: fromEntries(
elements.map((element) => [element, state.attributes[element]])
),
});
});
},
requires: ['computeStyles'],
}),
[]
);
const popperOptions = React.useMemo(() => {
const newOptions = {
onFirstUpdate: optionsWithDefaults.onFirstUpdate,
placement: optionsWithDefaults.placement,
strategy: optionsWithDefaults.strategy,
modifiers: [
...optionsWithDefaults.modifiers,
updateStateModifier,
{ name: 'applyStyles', enabled: false },
],
};
if (isEqual(prevOptions.current, newOptions)) {
return prevOptions.current || newOptions;
} else {
prevOptions.current = newOptions;
return newOptions;
}
}, [
optionsWithDefaults.onFirstUpdate,
optionsWithDefaults.placement,
optionsWithDefaults.strategy,
optionsWithDefaults.modifiers,
updateStateModifier,
]);
const popperInstanceRef = React.useRef();
useIsomorphicLayoutEffect(() => {
if (popperInstanceRef.current) {
popperInstanceRef.current.setOptions(popperOptions);
}
}, [popperOptions]);
useIsomorphicLayoutEffect(() => {
if (referenceElement == null || popperElement == null) {
return;
}
const createPopper = options.createPopper || defaultCreatePopper;
const popperInstance = createPopper(
referenceElement,
popperElement,
popperOptions
);
popperInstanceRef.current = popperInstance;
return () => {
popperInstance.destroy();
popperInstanceRef.current = null;
};
}, [referenceElement, popperElement, options.createPopper]);
return {
state: popperInstanceRef.current ? popperInstanceRef.current.state : null,
styles: state.styles,
attributes: state.attributes,
update: popperInstanceRef.current ? popperInstanceRef.current.update : null,
forceUpdate: popperInstanceRef.current
? popperInstanceRef.current.forceUpdate
: null,
};
};