@fluentui/react-positioning 0.0.0-nightly9edaf68d4420211116.1 → 0.0.0-nightlya0aef7969220220228.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (78) hide show
  1. package/CHANGELOG.json +189 -8
  2. package/CHANGELOG.md +53 -7
  3. package/dist/react-positioning.d.ts +113 -35
  4. package/lib/createArrowStyles.d.ts +64 -0
  5. package/lib/createArrowStyles.js +87 -0
  6. package/lib/createArrowStyles.js.map +1 -0
  7. package/lib/createVirtualElementFromClick.js +17 -15
  8. package/lib/createVirtualElementFromClick.js.map +1 -1
  9. package/lib/index.d.ts +2 -1
  10. package/lib/index.js +2 -1
  11. package/lib/index.js.map +1 -1
  12. package/lib/isIntersectingModifier.d.ts +4 -0
  13. package/lib/isIntersectingModifier.js +26 -0
  14. package/lib/isIntersectingModifier.js.map +1 -0
  15. package/lib/types.d.ts +28 -7
  16. package/lib/types.js.map +1 -1
  17. package/lib/usePopper.d.ts +2 -14
  18. package/lib/usePopper.js +368 -311
  19. package/lib/usePopper.js.map +1 -1
  20. package/lib/usePopperMouseTarget.js +28 -22
  21. package/lib/usePopperMouseTarget.js.map +1 -1
  22. package/lib/utils/getBasePlacement.js +1 -1
  23. package/lib/utils/getBasePlacement.js.map +1 -1
  24. package/lib/utils/getBoundary.js +15 -10
  25. package/lib/utils/getBoundary.js.map +1 -1
  26. package/lib/utils/getReactFiberFromNode.js +39 -35
  27. package/lib/utils/getReactFiberFromNode.js.map +1 -1
  28. package/lib/utils/getScrollParent.js +46 -32
  29. package/lib/utils/getScrollParent.js.map +1 -1
  30. package/lib/utils/index.js.map +1 -1
  31. package/lib/utils/mergeArrowOffset.js +29 -24
  32. package/lib/utils/mergeArrowOffset.js.map +1 -1
  33. package/lib/utils/positioningHelper.d.ts +2 -2
  34. package/lib/utils/positioningHelper.js +38 -30
  35. package/lib/utils/positioningHelper.js.map +1 -1
  36. package/lib/utils/resolvePositioningShorthand.js +57 -19
  37. package/lib/utils/resolvePositioningShorthand.js.map +1 -1
  38. package/lib/utils/useCallbackRef.js +35 -29
  39. package/lib/utils/useCallbackRef.js.map +1 -1
  40. package/lib-commonjs/createArrowStyles.d.ts +64 -0
  41. package/lib-commonjs/createArrowStyles.js +100 -0
  42. package/lib-commonjs/createArrowStyles.js.map +1 -0
  43. package/lib-commonjs/createVirtualElementFromClick.js +23 -16
  44. package/lib-commonjs/createVirtualElementFromClick.js.map +1 -1
  45. package/lib-commonjs/index.d.ts +2 -1
  46. package/lib-commonjs/index.js +28 -6
  47. package/lib-commonjs/index.js.map +1 -1
  48. package/lib-commonjs/isIntersectingModifier.d.ts +4 -0
  49. package/lib-commonjs/isIntersectingModifier.js +34 -0
  50. package/lib-commonjs/isIntersectingModifier.js.map +1 -0
  51. package/lib-commonjs/types.d.ts +28 -7
  52. package/lib-commonjs/types.js +4 -1
  53. package/lib-commonjs/types.js.map +1 -1
  54. package/lib-commonjs/usePopper.d.ts +2 -14
  55. package/lib-commonjs/usePopper.js +384 -316
  56. package/lib-commonjs/usePopper.js.map +1 -1
  57. package/lib-commonjs/usePopperMouseTarget.js +38 -25
  58. package/lib-commonjs/usePopperMouseTarget.js.map +1 -1
  59. package/lib-commonjs/utils/getBasePlacement.js +7 -2
  60. package/lib-commonjs/utils/getBasePlacement.js.map +1 -1
  61. package/lib-commonjs/utils/getBoundary.js +23 -12
  62. package/lib-commonjs/utils/getBoundary.js.map +1 -1
  63. package/lib-commonjs/utils/getReactFiberFromNode.js +44 -36
  64. package/lib-commonjs/utils/getReactFiberFromNode.js.map +1 -1
  65. package/lib-commonjs/utils/getScrollParent.js +53 -33
  66. package/lib-commonjs/utils/getScrollParent.js.map +1 -1
  67. package/lib-commonjs/utils/index.js +14 -2
  68. package/lib-commonjs/utils/index.js.map +1 -1
  69. package/lib-commonjs/utils/mergeArrowOffset.js +35 -25
  70. package/lib-commonjs/utils/mergeArrowOffset.js.map +1 -1
  71. package/lib-commonjs/utils/positioningHelper.d.ts +2 -2
  72. package/lib-commonjs/utils/positioningHelper.js +46 -31
  73. package/lib-commonjs/utils/positioningHelper.js.map +1 -1
  74. package/lib-commonjs/utils/resolvePositioningShorthand.js +65 -22
  75. package/lib-commonjs/utils/resolvePositioningShorthand.js.map +1 -1
  76. package/lib-commonjs/utils/useCallbackRef.js +45 -32
  77. package/lib-commonjs/utils/useCallbackRef.js.map +1 -1
  78. package/package.json +8 -7
@@ -1,32 +1,45 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
3
6
  exports.usePopper = void 0;
4
- const react_utilities_1 = require("@fluentui/react-utilities");
5
- const react_shared_contexts_1 = require("@fluentui/react-shared-contexts");
6
- const index_1 = require("./utils/index");
7
- const PopperJs = require("@popperjs/core");
8
- const React = require("react");
9
- //
7
+
8
+ const react_utilities_1 = /*#__PURE__*/require("@fluentui/react-utilities");
9
+
10
+ const react_shared_contexts_1 = /*#__PURE__*/require("@fluentui/react-shared-contexts");
11
+
12
+ const PopperJs = /*#__PURE__*/require("@popperjs/core");
13
+
14
+ const React = /*#__PURE__*/require("react");
15
+
16
+ const isIntersectingModifier_1 = /*#__PURE__*/require("./isIntersectingModifier");
17
+
18
+ const index_1 = /*#__PURE__*/require("./utils/index"); //
10
19
  // Dev utils to detect if nodes have "autoFocus" props.
11
20
  //
21
+
12
22
  /**
13
23
  * Detects if a passed HTML node has "autoFocus" prop on a React's fiber. Is needed as React handles autofocus behavior
14
24
  * in React DOM and will not pass "autoFocus" to an actual HTML.
15
25
  */
26
+
27
+
16
28
  function hasAutofocusProp(node) {
17
- var _a;
18
- // https://github.com/facebook/react/blob/848bb2426e44606e0a55dfe44c7b3ece33772485/packages/react-dom/src/client/ReactDOMHostConfig.js#L157-L166
19
- const isAutoFocusableElement = node.nodeName === 'BUTTON' ||
20
- node.nodeName === 'INPUT' ||
21
- node.nodeName === 'SELECT' ||
22
- node.nodeName === 'TEXTAREA';
23
- if (isAutoFocusableElement) {
24
- return !!((_a = index_1.getReactFiberFromNode(node)) === null || _a === void 0 ? void 0 : _a.pendingProps.autoFocus);
25
- }
26
- return false;
29
+ var _a; // https://github.com/facebook/react/blob/848bb2426e44606e0a55dfe44c7b3ece33772485/packages/react-dom/src/client/ReactDOMHostConfig.js#L157-L166
30
+
31
+
32
+ const isAutoFocusableElement = node.nodeName === 'BUTTON' || node.nodeName === 'INPUT' || node.nodeName === 'SELECT' || node.nodeName === 'TEXTAREA';
33
+
34
+ if (isAutoFocusableElement) {
35
+ return !!((_a = index_1.getReactFiberFromNode(node)) === null || _a === void 0 ? void 0 : _a.pendingProps.autoFocus);
36
+ }
37
+
38
+ return false;
27
39
  }
40
+
28
41
  function hasAutofocusFilter(node) {
29
- return hasAutofocusProp(node) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP;
42
+ return hasAutofocusProp(node) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP;
30
43
  }
31
44
  /**
32
45
  * Provides a callback to resolve Popper options, it's stable and should be used as a dependency to trigger updates
@@ -35,188 +48,217 @@ function hasAutofocusFilter(node) {
35
48
  * A callback is used there intentionally as some of Popper.js modifiers require DOM nodes (targer, container, arrow)
36
49
  * that can't be resolved properly during an initial rendering.
37
50
  */
51
+
52
+
38
53
  function usePopperOptions(options, popperOriginalPositionRef) {
39
- const { arrowPadding, autoSize, coverTarget, flipBoundary, offset, onStateUpdate, overflowBoundary,
54
+ const {
55
+ align,
56
+ arrowPadding,
57
+ autoSize,
58
+ coverTarget,
59
+ flipBoundary,
60
+ offset,
61
+ overflowBoundary,
62
+ pinned,
63
+ position,
64
+ positionFixed,
40
65
  // eslint-disable-next-line @typescript-eslint/naming-convention
41
- unstable_disableTether, pinned, } = options;
42
- const isRtl = react_shared_contexts_1.useFluent().dir === 'rtl';
43
- const placement = index_1.getPlacement(options.align, options.position, isRtl);
44
- const strategy = options.positionFixed ? 'fixed' : 'absolute';
45
- const handleStateUpdate = react_utilities_1.useEventCallback(({ state }) => {
46
- if (onStateUpdate) {
47
- onStateUpdate(state);
48
- }
49
- });
50
- const offsetModifier = React.useMemo(() => offset
51
- ? {
52
- name: 'offset',
53
- options: { offset: isRtl ? index_1.applyRtlToOffset(offset) : offset },
66
+ unstable_disableTether
67
+ } = options;
68
+ const isRtl = react_shared_contexts_1.useFluent().dir === 'rtl';
69
+ const placement = index_1.getPlacement(align, position, isRtl);
70
+ const strategy = positionFixed ? 'fixed' : 'absolute';
71
+ const offsetModifier = React.useMemo(() => offset ? {
72
+ name: 'offset',
73
+ options: {
74
+ offset: isRtl ? index_1.applyRtlToOffset(offset) : offset
75
+ }
76
+ } : null, [offset, isRtl]);
77
+ return React.useCallback((target, container, arrow) => {
78
+ var _a;
79
+
80
+ const scrollParentElement = index_1.getScrollParent(container);
81
+ const hasScrollableElement = scrollParentElement ? scrollParentElement !== ((_a = scrollParentElement.ownerDocument) === null || _a === void 0 ? void 0 : _a.body) : false;
82
+ const modifiers = [isIntersectingModifier_1.isIntersectingModifier,
83
+ /**
84
+ * We are setting the position to `fixed` in the first effect to prevent scroll jumps in case of the content
85
+ * with managed focus. Modifier sets the position to `fixed` before all other modifier effects. Another part of
86
+ * a patch modifies ".forceUpdate()" directly after a Popper will be created.
87
+ */
88
+ {
89
+ name: 'positionStyleFix',
90
+ enabled: true,
91
+ phase: 'afterWrite',
92
+ effect: ({
93
+ state,
94
+ instance
95
+ }) => {
96
+ // ".isFirstRun" is a part of our patch, on a first evaluation it will "undefined"
97
+ // should be disabled for subsequent runs as it breaks positioning for them
98
+ if (instance.isFirstRun !== false) {
99
+ popperOriginalPositionRef.current = state.elements.popper.style.position;
100
+ state.elements.popper.style.position = 'fixed';
54
101
  }
55
- : null, [offset, isRtl]);
56
- return React.useCallback((target, container, arrow) => {
57
- var _a;
58
- const scrollParentElement = index_1.getScrollParent(container);
59
- const hasScrollableElement = scrollParentElement
60
- ? scrollParentElement !== ((_a = scrollParentElement.ownerDocument) === null || _a === void 0 ? void 0 : _a.body)
61
- : false;
62
- const modifiers = [
63
- /**
64
- * We are setting the position to `fixed` in the first effect to prevent scroll jumps in case of the content
65
- * with managed focus. Modifier sets the position to `fixed` before all other modifier effects. Another part of
66
- * a patch modifies ".forceUpdate()" directly after a Popper will be created.
67
- */
68
- {
69
- name: 'positionStyleFix',
70
- enabled: true,
71
- phase: 'afterWrite',
72
- effect: ({ state, instance }) => {
73
- // ".isFirstRun" is a part of our patch, on a first evaluation it will "undefined"
74
- // should be disabled for subsequent runs as it breaks positioning for them
75
- if (instance.isFirstRun !== false) {
76
- popperOriginalPositionRef.current = state.elements.popper.style.position;
77
- state.elements.popper.style.position = 'fixed';
78
- }
79
- return () => undefined;
80
- },
81
- requires: [],
82
- },
83
- { name: 'flip', options: { flipVariations: true } },
84
- /**
85
- * pinned disables the flip modifier by setting flip.enabled to false; this
86
- * disables automatic repositioning of the popper box; it will always be placed according to
87
- * the values of `align` and `position` props, regardless of the size of the component, the
88
- * reference element or the viewport.
89
- */
90
- pinned && { name: 'flip', enabled: false },
91
- /**
92
- * When the popper box is placed in the context of a scrollable element, we need to set
93
- * preventOverflow.escapeWithReference to true and flip.boundariesElement to 'scrollParent'
94
- * (default is 'viewport') so that the popper box will stick with the targetRef when we
95
- * scroll targetRef out of the viewport.
96
- */
97
- hasScrollableElement && { name: 'flip', options: { boundary: 'clippingParents' } },
98
- hasScrollableElement && { name: 'preventOverflow', options: { boundary: 'clippingParents' } },
99
- offsetModifier,
100
- /**
101
- * This modifier is necessary to retain behaviour from popper v1 where untethered poppers are allowed by
102
- * default. i.e. popper is still rendered fully in the viewport even if anchor element is no longer in the
103
- * viewport.
104
- */
105
- unstable_disableTether && {
106
- name: 'preventOverflow',
107
- options: { altAxis: unstable_disableTether === 'all', tether: false },
108
- },
109
- flipBoundary && {
110
- name: 'flip',
111
- options: {
112
- altBoundary: true,
113
- boundary: index_1.getBoundary(container, flipBoundary),
114
- },
115
- },
116
- overflowBoundary && {
117
- name: 'preventOverflow',
118
- options: {
119
- altBoundary: true,
120
- boundary: index_1.getBoundary(container, overflowBoundary),
121
- },
122
- },
123
- {
124
- name: 'onUpdate',
125
- enabled: true,
126
- phase: 'afterWrite',
127
- fn: handleStateUpdate,
128
- },
129
- {
130
- // Similar code as popper-maxsize-modifier: https://github.com/atomiks/popper.js/blob/master/src/modifiers/maxSize.js
131
- // popper-maxsize-modifier only calculates the max sizes.
132
- // This modifier can apply max sizes always, or apply the max sizes only when overflow is detected
133
- name: 'applyMaxSize',
134
- enabled: !!autoSize,
135
- phase: 'beforeWrite',
136
- requiresIfExists: ['offset', 'preventOverflow', 'flip'],
137
- options: {
138
- altBoundary: true,
139
- boundary: index_1.getBoundary(container, overflowBoundary),
140
- },
141
- fn({ state, options: modifierOptions }) {
142
- const overflow = PopperJs.detectOverflow(state, modifierOptions);
143
- const { x, y } = state.modifiersData.preventOverflow || { x: 0, y: 0 };
144
- const { width, height } = state.rects.popper;
145
- const basePlacement = index_1.getBasePlacement(state.placement);
146
- const widthProp = basePlacement === 'left' ? 'left' : 'right';
147
- const heightProp = basePlacement === 'top' ? 'top' : 'bottom';
148
- const applyMaxWidth = autoSize === 'always' ||
149
- autoSize === 'width-always' ||
150
- (overflow[widthProp] > 0 && (autoSize === true || autoSize === 'width'));
151
- const applyMaxHeight = autoSize === 'always' ||
152
- autoSize === 'height-always' ||
153
- (overflow[heightProp] > 0 && (autoSize === true || autoSize === 'height'));
154
- if (applyMaxWidth) {
155
- state.styles.popper.maxWidth = `${width - overflow[widthProp] - x}px`;
156
- }
157
- if (applyMaxHeight) {
158
- state.styles.popper.maxHeight = `${height - overflow[heightProp] - y}px`;
159
- }
160
- },
161
- },
162
- /**
163
- * This modifier is necessary in order to render the pointer. Refs are resolved in effects, so it can't be
164
- * placed under computed modifiers. Deep merge is not required as this modifier has only these properties.
165
- */
166
- {
167
- name: 'arrow',
168
- enabled: !!arrow,
169
- options: { element: arrow, padding: arrowPadding },
170
- },
171
- /**
172
- * Modifies popper offsets to cover the reference rect, but still keep edge alignment
173
- */
174
- {
175
- name: 'coverTarget',
176
- enabled: !!coverTarget,
177
- phase: 'main',
178
- requiresIfExists: ['offset', 'preventOverflow', 'flip'],
179
- fn({ state }) {
180
- const basePlacement = index_1.getBasePlacement(state.placement);
181
- switch (basePlacement) {
182
- case 'bottom':
183
- state.modifiersData.popperOffsets.y -= state.rects.reference.height;
184
- break;
185
- case 'top':
186
- state.modifiersData.popperOffsets.y += state.rects.reference.height;
187
- break;
188
- case 'left':
189
- state.modifiersData.popperOffsets.x += state.rects.reference.width;
190
- break;
191
- case 'right':
192
- state.modifiersData.popperOffsets.x -= state.rects.reference.width;
193
- break;
194
- }
195
- },
196
- },
197
- ].filter(Boolean); // filter boolean conditional spreading values
198
- const popperOptions = {
199
- modifiers,
200
- placement,
201
- strategy,
202
- onFirstUpdate: state => handleStateUpdate({ state }),
102
+
103
+ return () => undefined;
104
+ },
105
+ requires: []
106
+ }, {
107
+ name: 'flip',
108
+ options: {
109
+ flipVariations: true
110
+ }
111
+ },
112
+ /**
113
+ * pinned disables the flip modifier by setting flip.enabled to false; this
114
+ * disables automatic repositioning of the popper box; it will always be placed according to
115
+ * the values of `align` and `position` props, regardless of the size of the component, the
116
+ * reference element or the viewport.
117
+ */
118
+ pinned && {
119
+ name: 'flip',
120
+ enabled: false
121
+ },
122
+ /**
123
+ * When the popper box is placed in the context of a scrollable element, we need to set
124
+ * preventOverflow.escapeWithReference to true and flip.boundariesElement to 'scrollParent'
125
+ * (default is 'viewport') so that the popper box will stick with the targetRef when we
126
+ * scroll targetRef out of the viewport.
127
+ */
128
+ hasScrollableElement && {
129
+ name: 'flip',
130
+ options: {
131
+ boundary: 'clippingParents'
132
+ }
133
+ }, hasScrollableElement && {
134
+ name: 'preventOverflow',
135
+ options: {
136
+ boundary: 'clippingParents'
137
+ }
138
+ }, offsetModifier,
139
+ /**
140
+ * This modifier is necessary to retain behaviour from popper v1 where untethered poppers are allowed by
141
+ * default. i.e. popper is still rendered fully in the viewport even if anchor element is no longer in the
142
+ * viewport.
143
+ */
144
+ unstable_disableTether && {
145
+ name: 'preventOverflow',
146
+ options: {
147
+ altAxis: unstable_disableTether === 'all',
148
+ tether: false
149
+ }
150
+ }, flipBoundary && {
151
+ name: 'flip',
152
+ options: {
153
+ altBoundary: true,
154
+ boundary: index_1.getBoundary(container, flipBoundary)
155
+ }
156
+ }, overflowBoundary && {
157
+ name: 'preventOverflow',
158
+ options: {
159
+ altBoundary: true,
160
+ boundary: index_1.getBoundary(container, overflowBoundary)
161
+ }
162
+ }, {
163
+ // Similar code as popper-maxsize-modifier: https://github.com/atomiks/popper.js/blob/master/src/modifiers/maxSize.js
164
+ // popper-maxsize-modifier only calculates the max sizes.
165
+ // This modifier can apply max sizes always, or apply the max sizes only when overflow is detected
166
+ name: 'applyMaxSize',
167
+ enabled: !!autoSize,
168
+ phase: 'beforeWrite',
169
+ requiresIfExists: ['offset', 'preventOverflow', 'flip'],
170
+ options: {
171
+ altBoundary: true,
172
+ boundary: index_1.getBoundary(container, overflowBoundary)
173
+ },
174
+
175
+ fn({
176
+ state,
177
+ options: modifierOptions
178
+ }) {
179
+ const overflow = PopperJs.detectOverflow(state, modifierOptions);
180
+ const {
181
+ x,
182
+ y
183
+ } = state.modifiersData.preventOverflow || {
184
+ x: 0,
185
+ y: 0
203
186
  };
204
- return popperOptions;
205
- }, [
206
- arrowPadding,
207
- autoSize,
208
- coverTarget,
209
- flipBoundary,
210
- offsetModifier,
211
- overflowBoundary,
212
- placement,
213
- strategy,
214
- unstable_disableTether,
215
- pinned,
216
- // These can be skipped from deps as they will not ever change
217
- handleStateUpdate,
218
- popperOriginalPositionRef,
219
- ]);
187
+ const {
188
+ width,
189
+ height
190
+ } = state.rects.popper;
191
+ const basePlacement = index_1.getBasePlacement(state.placement);
192
+ const widthProp = basePlacement === 'left' ? 'left' : 'right';
193
+ const heightProp = basePlacement === 'top' ? 'top' : 'bottom';
194
+ const applyMaxWidth = autoSize === 'always' || autoSize === 'width-always' || overflow[widthProp] > 0 && (autoSize === true || autoSize === 'width');
195
+ const applyMaxHeight = autoSize === 'always' || autoSize === 'height-always' || overflow[heightProp] > 0 && (autoSize === true || autoSize === 'height');
196
+
197
+ if (applyMaxWidth) {
198
+ state.styles.popper.maxWidth = `${width - overflow[widthProp] - x}px`;
199
+ }
200
+
201
+ if (applyMaxHeight) {
202
+ state.styles.popper.maxHeight = `${height - overflow[heightProp] - y}px`;
203
+ }
204
+ }
205
+
206
+ },
207
+ /**
208
+ * This modifier is necessary in order to render the pointer. Refs are resolved in effects, so it can't be
209
+ * placed under computed modifiers. Deep merge is not required as this modifier has only these properties.
210
+ */
211
+ {
212
+ name: 'arrow',
213
+ enabled: !!arrow,
214
+ options: {
215
+ element: arrow,
216
+ padding: arrowPadding
217
+ }
218
+ },
219
+ /**
220
+ * Modifies popper offsets to cover the reference rect, but still keep edge alignment
221
+ */
222
+ {
223
+ name: 'coverTarget',
224
+ enabled: !!coverTarget,
225
+ phase: 'main',
226
+ requiresIfExists: ['offset', 'preventOverflow', 'flip'],
227
+
228
+ fn({
229
+ state
230
+ }) {
231
+ const basePlacement = index_1.getBasePlacement(state.placement);
232
+
233
+ switch (basePlacement) {
234
+ case 'bottom':
235
+ state.modifiersData.popperOffsets.y -= state.rects.reference.height;
236
+ break;
237
+
238
+ case 'top':
239
+ state.modifiersData.popperOffsets.y += state.rects.reference.height;
240
+ break;
241
+
242
+ case 'left':
243
+ state.modifiersData.popperOffsets.x += state.rects.reference.width;
244
+ break;
245
+
246
+ case 'right':
247
+ state.modifiersData.popperOffsets.x -= state.rects.reference.width;
248
+ break;
249
+ }
250
+ }
251
+
252
+ }].filter(Boolean); // filter boolean conditional spreading values
253
+
254
+ const popperOptions = {
255
+ modifiers,
256
+ placement,
257
+ strategy
258
+ };
259
+ return popperOptions;
260
+ }, [arrowPadding, autoSize, coverTarget, flipBoundary, offsetModifier, overflowBoundary, placement, strategy, unstable_disableTether, pinned, // These can be skipped from deps as they will not ever change
261
+ popperOriginalPositionRef]);
220
262
  }
221
263
  /**
222
264
  * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
@@ -226,129 +268,155 @@ function usePopperOptions(options, popperOriginalPositionRef) {
226
268
  * - contains a specific to React fix related to initial positioning when containers have components with managed focus
227
269
  * to avoid focus jumps
228
270
  */
271
+
272
+
229
273
  function usePopper(options = {}) {
230
- const { enabled = true } = options;
231
- const isFirstMount = react_utilities_1.useFirstMount();
232
- const popperOriginalPositionRef = React.useRef('absolute');
233
- const resolvePopperOptions = usePopperOptions(options, popperOriginalPositionRef);
234
- const popperInstanceRef = React.useRef(null);
235
- const handlePopperUpdate = react_utilities_1.useEventCallback(() => {
236
- var _a;
237
- (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.destroy();
238
- popperInstanceRef.current = null;
239
- const { target = targetRef.current } = options;
240
- let popperInstance = null;
241
- if (react_utilities_1.canUseDOM() && enabled) {
242
- if (target && containerRef.current) {
243
- popperInstance = PopperJs.createPopper(target, containerRef.current, resolvePopperOptions(target, containerRef.current, arrowRef.current));
244
- }
245
- }
246
- if (popperInstance) {
247
- /**
248
- * The patch updates `.forceUpdate()` Popper function which restores the original position before the first
249
- * forceUpdate() call. See also "positionStyleFix" modifier in usePopperOptions().
250
- */
251
- const originalForceUpdate = popperInstance.forceUpdate;
252
- popperInstance.isFirstRun = true;
253
- popperInstance.forceUpdate = () => {
254
- if (popperInstance === null || popperInstance === void 0 ? void 0 : popperInstance.isFirstRun) {
255
- popperInstance.state.elements.popper.style.position = popperOriginalPositionRef.current;
256
- popperInstance.isFirstRun = false;
257
- }
258
- originalForceUpdate();
259
- };
260
- }
261
- popperInstanceRef.current = popperInstance;
262
- });
263
- // Refs are managed by useCallbackRef() to handle ref updates scenarios.
264
- //
265
- // The first scenario are updates for a targetRef, we can handle it properly only via callback refs, but it causes
266
- // re-renders (we would like to avoid them).
267
- //
268
- // The second problem is related to refs resolution on React's layer: refs are resolved in the same order as effects
269
- // that causes an issue when you have a container inside a target, for example: a menu in ChatMessage.
270
- //
271
- // function ChatMessage(props) {
272
- // <div className="message" ref={targetRef}> // 3) ref will be resolved only now, but it's too late already
273
- // <Popper target={targetRef}> // 2) create a popper instance
274
- // <div className="menu" /> // 1) capture ref from this element
275
- // </Popper>
276
- // </div>
277
- // }
278
- //
279
- // Check a demo on CodeSandbox: https://codesandbox.io/s/popper-refs-emy60.
280
- //
281
- // This again can be solved with callback refs. It's not a huge issue as with hooks we are moving popper's creation
282
- // to ChatMessage itself, however, without `useCallback()` refs it's still a Pandora box.
283
- const targetRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
284
- const containerRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
285
- const arrowRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
286
- React.useImperativeHandle(options.popperRef, () => ({
287
- updatePosition: () => {
288
- var _a;
289
- (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.update();
290
- },
291
- }), []);
292
- react_utilities_1.useIsomorphicLayoutEffect(() => {
293
- handlePopperUpdate();
294
- return () => {
295
- var _a;
296
- (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.destroy();
297
- popperInstanceRef.current = null;
298
- };
299
- }, [handlePopperUpdate, options.enabled, options.target]);
300
- react_utilities_1.useIsomorphicLayoutEffect(() => {
301
- var _a;
302
- if (!isFirstMount) {
303
- (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.setOptions(resolvePopperOptions(options.target || targetRef.current, containerRef.current, arrowRef.current));
274
+ const {
275
+ enabled = true
276
+ } = options;
277
+ const isFirstMount = react_utilities_1.useFirstMount();
278
+ const popperOriginalPositionRef = React.useRef('absolute');
279
+ const resolvePopperOptions = usePopperOptions(options, popperOriginalPositionRef);
280
+ const popperInstanceRef = React.useRef(null);
281
+ const handlePopperUpdate = react_utilities_1.useEventCallback(() => {
282
+ var _a, _b;
283
+
284
+ (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.destroy();
285
+ popperInstanceRef.current = null;
286
+ const target = (_b = overrideTargetRef.current) !== null && _b !== void 0 ? _b : targetRef.current;
287
+ let popperInstance = null;
288
+
289
+ if (react_utilities_1.canUseDOM() && enabled) {
290
+ if (target && containerRef.current) {
291
+ popperInstance = PopperJs.createPopper(target, containerRef.current, resolvePopperOptions(target, containerRef.current, arrowRef.current));
292
+ }
293
+ }
294
+
295
+ if (popperInstance) {
296
+ /**
297
+ * The patch updates `.forceUpdate()` Popper function which restores the original position before the first
298
+ * forceUpdate() call. See also "positionStyleFix" modifier in usePopperOptions().
299
+ */
300
+ const originalForceUpdate = popperInstance.forceUpdate;
301
+ popperInstance.isFirstRun = true;
302
+
303
+ popperInstance.forceUpdate = () => {
304
+ if (popperInstance === null || popperInstance === void 0 ? void 0 : popperInstance.isFirstRun) {
305
+ popperInstance.state.elements.popper.style.position = popperOriginalPositionRef.current;
306
+ popperInstance.isFirstRun = false;
304
307
  }
305
- },
306
- // Missing deps:
307
- // options.target - The useIsomorphicLayoutEffect before this will create a new popper instance if target changes
308
- // isFirstMount - Should never change after mount
309
- // arrowRef, containerRef, targetRef - Stable between renders
310
- // eslint-disable-next-line react-hooks/exhaustive-deps
311
- [resolvePopperOptions]);
312
- if (process.env.NODE_ENV !== 'production') {
313
- // This checked should run only in development mode
314
- // eslint-disable-next-line react-hooks/rules-of-hooks
315
- React.useEffect(() => {
316
- var _a;
317
- if (containerRef.current) {
318
- const contentNode = containerRef.current;
319
- const treeWalker = (_a = contentNode.ownerDocument) === null || _a === void 0 ? void 0 : _a.createTreeWalker(contentNode, NodeFilter.SHOW_ELEMENT, {
320
- acceptNode: hasAutofocusFilter,
321
- });
322
- while (treeWalker === null || treeWalker === void 0 ? void 0 : treeWalker.nextNode()) {
323
- const node = treeWalker.currentNode;
324
- // eslint-disable-next-line no-console
325
- console.warn('<Popper>:', node);
326
- // eslint-disable-next-line no-console
327
- console.warn([
328
- '<Popper>: ^ this node contains "autoFocus" prop on a React element. This can break the initial',
329
- 'positioning of an element and cause a window jump effect. This issue occurs because React polyfills',
330
- '"autoFocus" behavior to solve inconsistencies between different browsers:',
331
- 'https://github.com/facebook/react/issues/11851#issuecomment-351787078',
332
- '\n',
333
- 'However, ".focus()" in this case occurs before any other React effects will be executed',
334
- '(React.useEffect(), componentDidMount(), etc.) and we can not prevent this behavior. If you really',
335
- 'want to use "autoFocus" please add "position: fixed" to styles of the element that is wrapped by',
336
- '"Popper".',
337
- `In general, it's not recommended to use "autoFocus" as it may break accessibility aspects:`,
338
- 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-autofocus.md',
339
- '\n',
340
- 'We suggest to use the "trapFocus" prop on Fluent components or a catch "ref" and then use',
341
- '"ref.current.focus" in React.useEffect():',
342
- 'https://reactjs.org/docs/refs-and-the-dom.html#adding-a-ref-to-a-dom-element',
343
- ].join(' '));
344
- }
345
- }
346
- // We run this check once, no need to add deps here
347
- // TODO: Should be rework to handle options.enabled and contentRef updates
348
- // eslint-disable-next-line react-hooks/exhaustive-deps
349
- }, []);
308
+
309
+ originalForceUpdate();
310
+ };
350
311
  }
351
- return { targetRef, containerRef, arrowRef };
312
+
313
+ popperInstanceRef.current = popperInstance;
314
+ }); // Refs are managed by useCallbackRef() to handle ref updates scenarios.
315
+ //
316
+ // The first scenario are updates for a targetRef, we can handle it properly only via callback refs, but it causes
317
+ // re-renders (we would like to avoid them).
318
+ //
319
+ // The second problem is related to refs resolution on React's layer: refs are resolved in the same order as effects
320
+ // that causes an issue when you have a container inside a target, for example: a menu in ChatMessage.
321
+ //
322
+ // function ChatMessage(props) {
323
+ // <div className="message" ref={targetRef}> // 3) ref will be resolved only now, but it's too late already
324
+ // <Popper target={targetRef}> // 2) create a popper instance
325
+ // <div className="menu" /> // 1) capture ref from this element
326
+ // </Popper>
327
+ // </div>
328
+ // }
329
+ //
330
+ // Check a demo on CodeSandbox: https://codesandbox.io/s/popper-refs-emy60.
331
+ //
332
+ // This again can be solved with callback refs. It's not a huge issue as with hooks we are moving popper's creation
333
+ // to ChatMessage itself, however, without `useCallback()` refs it's still a Pandora box.
334
+
335
+ const targetRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
336
+ const containerRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
337
+ const arrowRef = index_1.useCallbackRef(null, handlePopperUpdate, true); // Stores external target from options.target or setTarget
338
+
339
+ const overrideTargetRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
340
+ React.useImperativeHandle(options.popperRef, () => ({
341
+ updatePosition: () => {
342
+ var _a;
343
+
344
+ (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.update();
345
+ },
346
+ setTarget: target => {
347
+ if (options.target && process.env.NODE_ENV !== 'production') {
348
+ const err = new Error(); // eslint-disable-next-line no-console
349
+
350
+ console.warn('Imperative setTarget should not be used at the same time as target option'); // eslint-disable-next-line no-console
351
+
352
+ console.warn(err.stack);
353
+ }
354
+
355
+ overrideTargetRef.current = target;
356
+ }
357
+ }), // Missing deps:
358
+ // options.target - only used for a runtime warning
359
+ // targetRef - Stable between renders
360
+ // eslint-disable-next-line react-hooks/exhaustive-deps
361
+ []);
362
+ react_utilities_1.useIsomorphicLayoutEffect(() => {
363
+ if (options.target) {
364
+ overrideTargetRef.current = options.target;
365
+ }
366
+ }, [options.target, overrideTargetRef]);
367
+ react_utilities_1.useIsomorphicLayoutEffect(() => {
368
+ handlePopperUpdate();
369
+ return () => {
370
+ var _a;
371
+
372
+ (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.destroy();
373
+ popperInstanceRef.current = null;
374
+ };
375
+ }, [handlePopperUpdate, options.enabled]);
376
+ react_utilities_1.useIsomorphicLayoutEffect(() => {
377
+ var _a, _b;
378
+
379
+ if (!isFirstMount) {
380
+ (_a = popperInstanceRef.current) === null || _a === void 0 ? void 0 : _a.setOptions(resolvePopperOptions((_b = overrideTargetRef.current) !== null && _b !== void 0 ? _b : targetRef.current, containerRef.current, arrowRef.current));
381
+ }
382
+ }, // Missing deps:
383
+ // isFirstMount - Should never change after mount
384
+ // arrowRef, containerRef, targetRef - Stable between renders
385
+ // eslint-disable-next-line react-hooks/exhaustive-deps
386
+ [resolvePopperOptions]);
387
+
388
+ if (process.env.NODE_ENV !== 'production') {
389
+ // This checked should run only in development mode
390
+ // eslint-disable-next-line react-hooks/rules-of-hooks
391
+ React.useEffect(() => {
392
+ var _a;
393
+
394
+ if (containerRef.current) {
395
+ const contentNode = containerRef.current;
396
+ const treeWalker = (_a = contentNode.ownerDocument) === null || _a === void 0 ? void 0 : _a.createTreeWalker(contentNode, NodeFilter.SHOW_ELEMENT, {
397
+ acceptNode: hasAutofocusFilter
398
+ });
399
+
400
+ while (treeWalker === null || treeWalker === void 0 ? void 0 : treeWalker.nextNode()) {
401
+ const node = treeWalker.currentNode; // eslint-disable-next-line no-console
402
+
403
+ console.warn('<Popper>:', node); // eslint-disable-next-line no-console
404
+
405
+ console.warn(['<Popper>: ^ this node contains "autoFocus" prop on a React element. This can break the initial', 'positioning of an element and cause a window jump effect. This issue occurs because React polyfills', '"autoFocus" behavior to solve inconsistencies between different browsers:', 'https://github.com/facebook/react/issues/11851#issuecomment-351787078', '\n', 'However, ".focus()" in this case occurs before any other React effects will be executed', '(React.useEffect(), componentDidMount(), etc.) and we can not prevent this behavior. If you really', 'want to use "autoFocus" please add "position: fixed" to styles of the element that is wrapped by', '"Popper".', `In general, it's not recommended to use "autoFocus" as it may break accessibility aspects:`, 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-autofocus.md', '\n', 'We suggest to use the "trapFocus" prop on Fluent components or a catch "ref" and then use', '"ref.current.focus" in React.useEffect():', 'https://reactjs.org/docs/refs-and-the-dom.html#adding-a-ref-to-a-dom-element'].join(' '));
406
+ }
407
+ } // We run this check once, no need to add deps here
408
+ // TODO: Should be rework to handle options.enabled and contentRef updates
409
+ // eslint-disable-next-line react-hooks/exhaustive-deps
410
+
411
+ }, []);
412
+ }
413
+
414
+ return {
415
+ targetRef,
416
+ containerRef,
417
+ arrowRef
418
+ };
352
419
  }
420
+
353
421
  exports.usePopper = usePopper;
354
422
  //# sourceMappingURL=usePopper.js.map