forked from mantinedev/mantine
/
Popover.tsx
285 lines (243 loc) · 7.31 KB
/
Popover.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
/* eslint-disable react/no-unused-prop-types */
import React, { useRef, useState, useCallback } from 'react';
import { useId, useClickOutside } from '@mantine/hooks';
import {
useMantineTheme,
ClassNames,
Styles,
StylesApiProvider,
MantineNumberSize,
MantineShadow,
getDefaultZIndex,
useComponentDefaultProps,
} from '@mantine/styles';
import { MantineTransition } from '../Transition';
import { getFloatingPosition, FloatingPosition } from '../Floating';
import { usePopover } from './use-popover';
import { PopoverContextProvider } from './Popover.context';
import {
PopoverWidth,
PopoverMiddlewares,
PopoverStylesNames,
PopoverStylesParams,
} from './Popover.types';
import { PopoverTarget } from './PopoverTarget/PopoverTarget';
import { PopoverDropdown } from './PopoverDropdown/PopoverDropdown';
export interface PopoverBaseProps {
/** Dropdown position relative to target */
position?: FloatingPosition;
/** Space between target element and dropdown in px */
offset?: number;
/** Called when dropdown position changes */
onPositionChange?(position: FloatingPosition): void;
/** useEffect dependencies to force update dropdown position */
positionDependencies?: any[];
/** Called when dropdown closes */
onClose?(): void;
/** Called when dropdown opens */
onOpen?(): void;
/** One of premade transitions ot transition object */
transition?: MantineTransition;
/** Transition duration in ms */
transitionDuration?: number;
/** Exit transition duration in ms */
exitTransitionDuration?: number;
/** Dropdown width, or 'target' to make dropdown width the same as target element */
width?: PopoverWidth;
/** Floating ui middlewares to configure position handling */
middlewares?: PopoverMiddlewares;
/** Determines whether component should have an arrow */
withArrow?: boolean;
/** Arrow size in px */
arrowSize?: number;
/** Arrow offset in px */
arrowOffset?: number;
/** Arrow radius in px */
arrowRadius?: number;
/** Determines whether dropdown should be rendered within Portal, defaults to false */
withinPortal?: boolean;
/** Dropdown z-index */
zIndex?: React.CSSProperties['zIndex'];
/** Radius from theme.radius or number to set border-radius in px */
radius?: MantineNumberSize;
/** Key of theme.shadow or any other valid css box-shadow value */
shadow?: MantineShadow;
/** If set, popover dropdown will not render */
disabled?: boolean;
/** Determines whether focus should be automatically returned to control when dropdown closes, false by default */
returnFocus?: boolean;
}
export interface PopoverProps extends PopoverBaseProps {
/** Popover.Target and Popover.Dropdown components */
children: React.ReactNode;
/** Initial opened state for uncontrolled component */
defaultOpened?: boolean;
/** Controls dropdown opened state */
opened?: boolean;
/** Called with current state when dropdown opens or closes */
onChange?(opened: boolean): void;
/** Determines whether dropdown should be closed on outside clicks, default to true */
closeOnClickOutside?: boolean;
/** Events that trigger outside clicks */
clickOutsideEvents?: string[];
/** Determines whether focus should be trapped within dropdown, default to false */
trapFocus?: boolean;
/** Determines whether dropdown should be closed when Escape key is pressed, defaults to true */
closeOnEscape?: boolean;
/** id base to create accessibility connections */
id?: string;
/** Determines whether dropdown and target element should have accessible roles, defaults to true */
withRoles?: boolean;
unstyled?: boolean;
classNames?: ClassNames<PopoverStylesNames>;
styles?: Styles<PopoverStylesNames, PopoverStylesParams>;
__staticSelector?: string;
}
const defaultProps: Partial<PopoverProps> = {
position: 'bottom',
offset: 8,
positionDependencies: [],
transition: 'fade',
transitionDuration: 150,
middlewares: { flip: true, shift: true, inline: false },
arrowSize: 7,
arrowOffset: 5,
arrowRadius: 0,
closeOnClickOutside: true,
withinPortal: false,
closeOnEscape: true,
trapFocus: false,
withRoles: true,
returnFocus: false,
clickOutsideEvents: ['mousedown', 'touchstart'],
zIndex: getDefaultZIndex('popover'),
__staticSelector: 'Popover',
width: 'max-content',
};
export function Popover(props: PopoverProps) {
const arrowRef = useRef<HTMLDivElement | null>(null);
const {
children,
position,
offset,
onPositionChange,
positionDependencies,
opened,
transition,
transitionDuration,
width,
middlewares,
withArrow,
arrowSize,
arrowOffset,
arrowRadius,
unstyled,
classNames,
styles,
closeOnClickOutside,
withinPortal,
closeOnEscape,
clickOutsideEvents,
trapFocus,
onClose,
onOpen,
onChange,
zIndex,
radius,
shadow,
id,
defaultOpened,
exitTransitionDuration,
__staticSelector,
withRoles,
disabled,
returnFocus,
...others
} = useComponentDefaultProps('Popover', defaultProps, props);
const [targetNode, setTargetNode] = useState<HTMLElement>(null);
const [dropdownNode, setDropdownNode] = useState<HTMLElement>(null);
const uid = useId(id);
const theme = useMantineTheme();
const popover = usePopover({
middlewares,
width,
position: getFloatingPosition(theme.dir, position),
offset: offset + (withArrow ? arrowSize / 2 : 0),
arrowRef,
arrowOffset,
onPositionChange,
positionDependencies,
opened,
defaultOpened,
onChange,
onOpen,
onClose,
});
useClickOutside(() => closeOnClickOutside && popover.onClose(), clickOutsideEvents, [
targetNode,
dropdownNode,
]);
const reference = useCallback(
(node: HTMLElement) => {
setTargetNode(node);
popover.floating.reference(node);
},
[popover.floating.reference]
);
const floating = useCallback(
(node: HTMLElement) => {
setDropdownNode(node);
popover.floating.floating(node);
},
[popover.floating.floating]
);
return (
<StylesApiProvider
classNames={classNames}
styles={styles}
unstyled={unstyled}
staticSelector={__staticSelector}
>
<PopoverContextProvider
value={{
returnFocus,
disabled,
controlled: popover.controlled,
reference,
floating,
x: popover.floating.x,
y: popover.floating.y,
arrowX: popover.floating?.middlewareData?.arrow?.x,
arrowY: popover.floating?.middlewareData?.arrow?.y,
opened: popover.opened,
arrowRef,
transition,
transitionDuration,
exitTransitionDuration,
width,
withArrow,
arrowSize,
arrowRadius,
placement: popover.floating.placement,
trapFocus,
withinPortal,
zIndex,
radius,
shadow,
closeOnEscape,
onClose: popover.onClose,
onToggle: popover.onToggle,
getTargetId: () => `${uid}-target`,
getDropdownId: () => `${uid}-dropdown`,
withRoles,
targetProps: others,
}}
>
{children}
</PopoverContextProvider>
</StylesApiProvider>
);
}
Popover.Target = PopoverTarget;
Popover.Dropdown = PopoverDropdown;
Popover.displayName = '@mantine/core/Popover';