@atlaskit/top-layer 0.12.1 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/dist/cjs/animations/presets.js +5 -5
- package/dist/cjs/dialog/create-close-event.js +1 -1
- package/dist/cjs/dialog/dialog-content.js +5 -5
- package/dist/cjs/entry-points/focus.js +6 -4
- package/dist/cjs/entry-points/use-anchor-position-at-point.js +12 -0
- package/dist/cjs/focus/get-first-focusable.js +19 -0
- package/dist/cjs/focus/get-focusables.js +30 -0
- package/dist/cjs/focus/get-last-focusable.js +19 -0
- package/dist/cjs/focus/get-next-focusable.js +43 -0
- package/dist/cjs/focus/is-in-same-layer.js +23 -0
- package/dist/cjs/focus/is-nested-layer-focused.js +32 -0
- package/dist/cjs/focus/selectors.js +19 -0
- package/dist/cjs/focus/types.js +1 -0
- package/dist/cjs/internal/ensure-preset-styles.js +1 -1
- package/dist/cjs/internal/reduced-motion.js +1 -1
- package/dist/cjs/internal/resolve-placement.js +2 -2
- package/dist/cjs/internal/role-to-aria-has-popup.js +37 -0
- package/dist/cjs/internal/role-types.js +1 -97
- package/dist/cjs/internal/should-focus-into-popover.js +19 -0
- package/dist/cjs/internal/slot.js +3 -3
- package/dist/cjs/internal/use-anchor-position-at-point.js +127 -0
- package/dist/cjs/internal/use-anchor-position.js +22 -33
- package/dist/cjs/internal/use-animated-visibility.js +10 -10
- package/dist/cjs/internal/use-animation-preset.js +1 -1
- package/dist/cjs/internal/use-focus-wrap.js +8 -5
- package/dist/cjs/internal/use-initial-focus.js +4 -4
- package/dist/cjs/internal/use-preset-styles.js +1 -1
- package/dist/cjs/internal/use-width-from-anchor.js +4 -4
- package/dist/cjs/placement-map/index.js +2 -2
- package/dist/cjs/placement-map/legacy-placements.js +2 -101
- package/dist/cjs/placement-map/placement-mapping.js +103 -0
- package/dist/cjs/popover/create-close-event.js +1 -1
- package/dist/cjs/popover/popover.js +3 -3
- package/dist/cjs/popup/popup-content.js +8 -7
- package/dist/cjs/testing/polyfill.js +8 -8
- package/dist/cjs/testing/to-be-visible.js +5 -5
- package/dist/cjs/use-arrow-navigation/is-at-current-menu-level.js +19 -12
- package/dist/cjs/use-arrow-navigation/use-arrow-navigation.js +7 -5
- package/dist/cjs/use-simple-light-dismiss/index.js +3 -3
- package/dist/es2019/animations/presets.js +5 -5
- package/dist/es2019/dialog/create-close-event.js +1 -1
- package/dist/es2019/dialog/dialog-content.js +5 -5
- package/dist/es2019/entry-points/focus.js +3 -1
- package/dist/es2019/entry-points/use-anchor-position-at-point.js +1 -0
- package/dist/es2019/focus/get-first-focusable.js +14 -0
- package/dist/es2019/focus/get-focusables.js +19 -0
- package/dist/es2019/focus/get-last-focusable.js +14 -0
- package/dist/es2019/focus/get-next-focusable.js +38 -0
- package/dist/es2019/focus/is-in-same-layer.js +18 -0
- package/dist/es2019/focus/is-nested-layer-focused.js +28 -0
- package/dist/es2019/focus/selectors.js +11 -0
- package/dist/es2019/focus/types.js +0 -0
- package/dist/es2019/internal/ensure-preset-styles.js +1 -1
- package/dist/es2019/internal/reduced-motion.js +1 -1
- package/dist/es2019/internal/resolve-placement.js +2 -2
- package/dist/es2019/internal/role-to-aria-has-popup.js +32 -0
- package/dist/es2019/internal/role-types.js +0 -92
- package/dist/es2019/internal/should-focus-into-popover.js +14 -0
- package/dist/es2019/internal/slot.js +3 -3
- package/dist/es2019/internal/use-anchor-position-at-point.js +122 -0
- package/dist/es2019/internal/use-anchor-position.js +19 -19
- package/dist/es2019/internal/use-animated-visibility.js +10 -10
- package/dist/es2019/internal/use-animation-preset.js +1 -1
- package/dist/es2019/internal/use-focus-wrap.js +4 -1
- package/dist/es2019/internal/use-initial-focus.js +1 -1
- package/dist/es2019/internal/use-preset-styles.js +1 -1
- package/dist/es2019/internal/use-width-from-anchor.js +4 -4
- package/dist/es2019/placement-map/index.js +1 -1
- package/dist/es2019/placement-map/legacy-placements.js +1 -100
- package/dist/es2019/placement-map/placement-mapping.js +97 -0
- package/dist/es2019/popover/create-close-event.js +1 -1
- package/dist/es2019/popover/popover.js +3 -3
- package/dist/es2019/popup/popup-content.js +6 -5
- package/dist/es2019/testing/polyfill.js +8 -8
- package/dist/es2019/testing/to-be-visible.js +5 -5
- package/dist/es2019/use-arrow-navigation/is-at-current-menu-level.js +19 -12
- package/dist/es2019/use-arrow-navigation/use-arrow-navigation.js +3 -1
- package/dist/es2019/use-simple-light-dismiss/index.js +3 -3
- package/dist/esm/animations/presets.js +5 -5
- package/dist/esm/dialog/create-close-event.js +1 -1
- package/dist/esm/dialog/dialog-content.js +5 -5
- package/dist/esm/entry-points/focus.js +3 -1
- package/dist/esm/entry-points/use-anchor-position-at-point.js +1 -0
- package/dist/esm/focus/get-first-focusable.js +13 -0
- package/dist/esm/focus/get-focusables.js +24 -0
- package/dist/esm/focus/get-last-focusable.js +13 -0
- package/dist/esm/focus/get-next-focusable.js +37 -0
- package/dist/esm/focus/is-in-same-layer.js +17 -0
- package/dist/esm/focus/is-nested-layer-focused.js +27 -0
- package/dist/esm/focus/selectors.js +13 -0
- package/dist/esm/focus/types.js +0 -0
- package/dist/esm/internal/ensure-preset-styles.js +1 -1
- package/dist/esm/internal/reduced-motion.js +1 -1
- package/dist/esm/internal/resolve-placement.js +2 -2
- package/dist/esm/internal/role-to-aria-has-popup.js +31 -0
- package/dist/esm/internal/role-types.js +0 -90
- package/dist/esm/internal/should-focus-into-popover.js +13 -0
- package/dist/esm/internal/slot.js +3 -3
- package/dist/esm/internal/use-anchor-position-at-point.js +122 -0
- package/dist/esm/internal/use-anchor-position.js +22 -33
- package/dist/esm/internal/use-animated-visibility.js +10 -10
- package/dist/esm/internal/use-animation-preset.js +1 -1
- package/dist/esm/internal/use-focus-wrap.js +4 -1
- package/dist/esm/internal/use-initial-focus.js +1 -1
- package/dist/esm/internal/use-preset-styles.js +1 -1
- package/dist/esm/internal/use-width-from-anchor.js +4 -4
- package/dist/esm/placement-map/index.js +1 -1
- package/dist/esm/placement-map/legacy-placements.js +1 -100
- package/dist/esm/placement-map/placement-mapping.js +97 -0
- package/dist/esm/popover/create-close-event.js +1 -1
- package/dist/esm/popover/popover.js +3 -3
- package/dist/esm/popup/popup-content.js +6 -5
- package/dist/esm/testing/polyfill.js +8 -8
- package/dist/esm/testing/to-be-visible.js +5 -5
- package/dist/esm/use-arrow-navigation/is-at-current-menu-level.js +19 -12
- package/dist/esm/use-arrow-navigation/use-arrow-navigation.js +3 -1
- package/dist/esm/use-simple-light-dismiss/index.js +3 -3
- package/dist/types/dialog/create-close-event.d.ts +1 -1
- package/dist/types/dialog/types.d.ts +8 -0
- package/dist/types/entry-points/focus.d.ts +4 -2
- package/dist/types/entry-points/use-anchor-position-at-point.d.ts +1 -0
- package/dist/types/focus/get-first-focusable.d.ts +8 -0
- package/dist/types/focus/get-focusables.d.ts +13 -0
- package/dist/types/focus/get-last-focusable.d.ts +8 -0
- package/dist/types/focus/get-next-focusable.d.ts +13 -0
- package/dist/types/focus/is-in-same-layer.d.ts +8 -0
- package/dist/types/focus/is-nested-layer-focused.d.ts +8 -0
- package/dist/types/focus/selectors.d.ts +4 -0
- package/dist/types/focus/types.d.ts +5 -0
- package/dist/types/internal/reduced-motion.d.ts +1 -1
- package/dist/types/internal/resolve-placement.d.ts +2 -2
- package/dist/types/internal/role-to-aria-has-popup.d.ts +13 -0
- package/dist/types/internal/role-types.d.ts +0 -19
- package/dist/types/internal/should-focus-into-popover.d.ts +8 -0
- package/dist/types/internal/slot.d.ts +4 -4
- package/dist/types/internal/use-anchor-position-at-point.d.ts +62 -0
- package/dist/types/internal/use-anchor-position.d.ts +6 -1
- package/dist/types/internal/use-animated-visibility.d.ts +3 -3
- package/dist/types/internal/use-animation-preset.d.ts +1 -1
- package/dist/types/internal/use-preset-styles.d.ts +1 -1
- package/dist/types/internal/use-width-from-anchor.d.ts +2 -2
- package/dist/types/placement-map/index.d.ts +1 -1
- package/dist/types/placement-map/legacy-placements.d.ts +0 -12
- package/dist/types/placement-map/placement-mapping.d.ts +13 -0
- package/dist/types/popover/create-close-event.d.ts +1 -1
- package/dist/types/popover/popover.d.ts +1 -1
- package/dist/types/popup/popup-context.d.ts +1 -1
- package/dist/types/testing/to-be-visible.d.ts +3 -3
- package/dist/types/use-arrow-navigation/use-arrow-navigation.d.ts +1 -1
- package/dist/types/use-simple-light-dismiss/index.d.ts +1 -1
- package/dist/types-ts4.5/dialog/create-close-event.d.ts +1 -1
- package/dist/types-ts4.5/dialog/types.d.ts +8 -0
- package/dist/types-ts4.5/entry-points/focus.d.ts +4 -2
- package/dist/types-ts4.5/entry-points/use-anchor-position-at-point.d.ts +1 -0
- package/dist/types-ts4.5/focus/get-first-focusable.d.ts +8 -0
- package/dist/types-ts4.5/focus/get-focusables.d.ts +13 -0
- package/dist/types-ts4.5/focus/get-last-focusable.d.ts +8 -0
- package/dist/types-ts4.5/focus/get-next-focusable.d.ts +13 -0
- package/dist/types-ts4.5/focus/is-in-same-layer.d.ts +8 -0
- package/dist/types-ts4.5/focus/is-nested-layer-focused.d.ts +8 -0
- package/dist/types-ts4.5/focus/selectors.d.ts +4 -0
- package/dist/types-ts4.5/focus/types.d.ts +5 -0
- package/dist/types-ts4.5/internal/reduced-motion.d.ts +1 -1
- package/dist/types-ts4.5/internal/resolve-placement.d.ts +2 -2
- package/dist/types-ts4.5/internal/role-to-aria-has-popup.d.ts +13 -0
- package/dist/types-ts4.5/internal/role-types.d.ts +0 -19
- package/dist/types-ts4.5/internal/should-focus-into-popover.d.ts +8 -0
- package/dist/types-ts4.5/internal/slot.d.ts +4 -4
- package/dist/types-ts4.5/internal/use-anchor-position-at-point.d.ts +62 -0
- package/dist/types-ts4.5/internal/use-anchor-position.d.ts +6 -1
- package/dist/types-ts4.5/internal/use-animated-visibility.d.ts +3 -3
- package/dist/types-ts4.5/internal/use-animation-preset.d.ts +1 -1
- package/dist/types-ts4.5/internal/use-preset-styles.d.ts +1 -1
- package/dist/types-ts4.5/internal/use-width-from-anchor.d.ts +2 -2
- package/dist/types-ts4.5/placement-map/index.d.ts +1 -1
- package/dist/types-ts4.5/placement-map/legacy-placements.d.ts +0 -12
- package/dist/types-ts4.5/placement-map/placement-mapping.d.ts +13 -0
- package/dist/types-ts4.5/popover/create-close-event.d.ts +1 -1
- package/dist/types-ts4.5/popover/popover.d.ts +1 -1
- package/dist/types-ts4.5/popup/popup-context.d.ts +1 -1
- package/dist/types-ts4.5/testing/to-be-visible.d.ts +3 -3
- package/dist/types-ts4.5/use-arrow-navigation/use-arrow-navigation.d.ts +1 -1
- package/dist/types-ts4.5/use-simple-light-dismiss/index.d.ts +1 -1
- package/package.json +1 -1
- package/use-anchor-position-at-point/package.json +17 -0
- package/dist/cjs/focus/focus.js +0 -169
- package/dist/cjs/focus/index.js +0 -24
- package/dist/es2019/focus/focus.js +0 -158
- package/dist/es2019/focus/index.js +0 -1
- package/dist/esm/focus/focus.js +0 -160
- package/dist/esm/focus/index.js +0 -1
- package/dist/types/focus/focus.d.ts +0 -50
- package/dist/types/focus/index.d.ts +0 -2
- package/dist/types-ts4.5/focus/focus.d.ts +0 -50
- package/dist/types-ts4.5/focus/index.d.ts +0 -2
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The full mapping record. Internal - use `fromLegacyPlacement` from the
|
|
3
|
+
* public entry-point so the offset-tuple translation is applied consistently.
|
|
4
|
+
*
|
|
5
|
+
* Note: `auto`, `auto-start`, `auto-end` map to `block-end` placements. This
|
|
6
|
+
* is a reduction in expressiveness vs Popper.js (which picked the best
|
|
7
|
+
* placement at runtime). CSS `position-try-fallbacks` flips at the edge but
|
|
8
|
+
* the initial placement is fixed. Migration consumers who relied on Popper's
|
|
9
|
+
* dynamic auto-flip should pick an explicit placement instead.
|
|
10
|
+
*/
|
|
11
|
+
export var placementMapping = {
|
|
12
|
+
top: {
|
|
13
|
+
axis: 'block',
|
|
14
|
+
edge: 'start',
|
|
15
|
+
align: 'center'
|
|
16
|
+
},
|
|
17
|
+
'top-start': {
|
|
18
|
+
axis: 'block',
|
|
19
|
+
edge: 'start',
|
|
20
|
+
align: 'start'
|
|
21
|
+
},
|
|
22
|
+
'top-center': {
|
|
23
|
+
axis: 'block',
|
|
24
|
+
edge: 'start',
|
|
25
|
+
align: 'center'
|
|
26
|
+
},
|
|
27
|
+
'top-end': {
|
|
28
|
+
axis: 'block',
|
|
29
|
+
edge: 'start',
|
|
30
|
+
align: 'end'
|
|
31
|
+
},
|
|
32
|
+
bottom: {
|
|
33
|
+
axis: 'block',
|
|
34
|
+
edge: 'end',
|
|
35
|
+
align: 'center'
|
|
36
|
+
},
|
|
37
|
+
'bottom-start': {
|
|
38
|
+
axis: 'block',
|
|
39
|
+
edge: 'end',
|
|
40
|
+
align: 'start'
|
|
41
|
+
},
|
|
42
|
+
'bottom-center': {
|
|
43
|
+
axis: 'block',
|
|
44
|
+
edge: 'end',
|
|
45
|
+
align: 'center'
|
|
46
|
+
},
|
|
47
|
+
'bottom-end': {
|
|
48
|
+
axis: 'block',
|
|
49
|
+
edge: 'end',
|
|
50
|
+
align: 'end'
|
|
51
|
+
},
|
|
52
|
+
right: {
|
|
53
|
+
axis: 'inline',
|
|
54
|
+
edge: 'end',
|
|
55
|
+
align: 'center'
|
|
56
|
+
},
|
|
57
|
+
'right-start': {
|
|
58
|
+
axis: 'inline',
|
|
59
|
+
edge: 'end',
|
|
60
|
+
align: 'start'
|
|
61
|
+
},
|
|
62
|
+
'right-end': {
|
|
63
|
+
axis: 'inline',
|
|
64
|
+
edge: 'end',
|
|
65
|
+
align: 'end'
|
|
66
|
+
},
|
|
67
|
+
left: {
|
|
68
|
+
axis: 'inline',
|
|
69
|
+
edge: 'start',
|
|
70
|
+
align: 'center'
|
|
71
|
+
},
|
|
72
|
+
'left-start': {
|
|
73
|
+
axis: 'inline',
|
|
74
|
+
edge: 'start',
|
|
75
|
+
align: 'start'
|
|
76
|
+
},
|
|
77
|
+
'left-end': {
|
|
78
|
+
axis: 'inline',
|
|
79
|
+
edge: 'start',
|
|
80
|
+
align: 'end'
|
|
81
|
+
},
|
|
82
|
+
auto: {
|
|
83
|
+
axis: 'block',
|
|
84
|
+
edge: 'end',
|
|
85
|
+
align: 'center'
|
|
86
|
+
},
|
|
87
|
+
'auto-start': {
|
|
88
|
+
axis: 'block',
|
|
89
|
+
edge: 'end',
|
|
90
|
+
align: 'start'
|
|
91
|
+
},
|
|
92
|
+
'auto-end': {
|
|
93
|
+
axis: 'block',
|
|
94
|
+
edge: 'end',
|
|
95
|
+
align: 'end'
|
|
96
|
+
}
|
|
97
|
+
};
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Creates a synthetic DOM event from a `TPopoverCloseReason`.
|
|
3
3
|
*
|
|
4
4
|
* Useful when bridging the Popover primitive's `onClose({ reason })` callback
|
|
5
|
-
* to a legacy API that expects a native DOM event
|
|
5
|
+
* to a legacy API that expects a native DOM event - for example,
|
|
6
6
|
* `@atlaskit/inline-dialog`'s `onClose(event)` contract.
|
|
7
7
|
*
|
|
8
8
|
* - `'escape'` → `KeyboardEvent('keydown', { key: 'Escape' })`
|
|
@@ -47,7 +47,7 @@ var POPUP_ROLES = new Set(['menu', 'listbox', 'dialog', 'alertdialog', 'tree', '
|
|
|
47
47
|
* Unopinionated top-layer primitive.
|
|
48
48
|
*
|
|
49
49
|
* Manages only visibility (isOpen) and animation (animate). Has no knowledge
|
|
50
|
-
* of positioning
|
|
50
|
+
* of positioning - compose with `useAnchorPosition` for anchor positioning
|
|
51
51
|
* and optionally `useWidthFromAnchor` for setting the width of a popover element
|
|
52
52
|
* relative to its anchor trigger.
|
|
53
53
|
*
|
|
@@ -96,7 +96,7 @@ export var Popover = /*#__PURE__*/forwardRef(function Popover(_ref, ref) {
|
|
|
96
96
|
showChildren = _useAnimatedVisibilit.showChildren,
|
|
97
97
|
preset = _useAnimatedVisibilit.preset;
|
|
98
98
|
|
|
99
|
-
//
|
|
99
|
+
// Focus management
|
|
100
100
|
// Initial focus: on open, moves focus into the popover (role-dependent).
|
|
101
101
|
// Focus wrap: Tab/Shift+Tab cycle within the popover for dialog roles.
|
|
102
102
|
// Focus restoration: handled natively by the Popover API. The browser
|
|
@@ -112,7 +112,7 @@ export var Popover = /*#__PURE__*/forwardRef(function Popover(_ref, ref) {
|
|
|
112
112
|
role: role
|
|
113
113
|
});
|
|
114
114
|
|
|
115
|
-
//
|
|
115
|
+
// Open layer observer registration
|
|
116
116
|
// Notifies the open layer observer so app-coordination features
|
|
117
117
|
// (closeLayers(), open-count subscriptions) work with top-layer popovers.
|
|
118
118
|
//
|
|
@@ -4,7 +4,8 @@ import { ax, ix } from "@compiled/react/runtime";
|
|
|
4
4
|
import React, { forwardRef, useCallback, useLayoutEffect, useRef } from 'react';
|
|
5
5
|
import mergeRefs from '@atlaskit/ds-lib/merge-refs';
|
|
6
6
|
import { prefersReducedMotion } from '../internal/reduced-motion';
|
|
7
|
-
import { roleToAriaHasPopup
|
|
7
|
+
import { roleToAriaHasPopup } from '../internal/role-to-aria-has-popup';
|
|
8
|
+
import { shouldFocusIntoPopover } from '../internal/should-focus-into-popover';
|
|
8
9
|
import { useAnchorPosition } from '../internal/use-anchor-position';
|
|
9
10
|
import { useWidthFromAnchor } from '../internal/use-width-from-anchor';
|
|
10
11
|
import { Popover } from '../popover/popover';
|
|
@@ -89,7 +90,7 @@ export var PopupContent = /*#__PURE__*/forwardRef(function PopupContent(_ref, re
|
|
|
89
90
|
// Note: onOpenChange composition is handled by handleOpenChange below,
|
|
90
91
|
// which also adds nested-popover focus restoration.
|
|
91
92
|
|
|
92
|
-
//
|
|
93
|
+
// Sync aria-haspopup on the trigger with the content's role
|
|
93
94
|
var setAriaHasPopup = ctx === null || ctx === void 0 ? void 0 : ctx.setAriaHasPopup;
|
|
94
95
|
useLayoutEffect(function () {
|
|
95
96
|
setAriaHasPopup === null || setAriaHasPopup === void 0 || setAriaHasPopup(roleToAriaHasPopup({
|
|
@@ -97,7 +98,7 @@ export var PopupContent = /*#__PURE__*/forwardRef(function PopupContent(_ref, re
|
|
|
97
98
|
}));
|
|
98
99
|
}, [role, setAriaHasPopup]);
|
|
99
100
|
|
|
100
|
-
//
|
|
101
|
+
// Focus restoration
|
|
101
102
|
// The native Popover API handles focus restoration automatically for
|
|
102
103
|
// popover="auto" and popover="hint":
|
|
103
104
|
// - Escape → restores focus to the previously focused element (the trigger)
|
|
@@ -124,7 +125,7 @@ export var PopupContent = /*#__PURE__*/forwardRef(function PopupContent(_ref, re
|
|
|
124
125
|
}
|
|
125
126
|
consumerOnOpenChange === null || consumerOnOpenChange === void 0 || consumerOnOpenChange(args);
|
|
126
127
|
|
|
127
|
-
//
|
|
128
|
+
// Nested popover focus restoration fallback
|
|
128
129
|
// The browser only captures `previouslyFocusedElement` for the
|
|
129
130
|
// outermost popover="auto" in the stack. Inner (nested) popovers
|
|
130
131
|
// have shouldRestoreFocus=false, so the browser will not restore
|
|
@@ -153,7 +154,7 @@ export var PopupContent = /*#__PURE__*/forwardRef(function PopupContent(_ref, re
|
|
|
153
154
|
}
|
|
154
155
|
}, [consumerOnOpenChange, triggerRef, role, setPopupState, willAnimate]);
|
|
155
156
|
|
|
156
|
-
//
|
|
157
|
+
// Anchor positioning
|
|
157
158
|
// Compose useAnchorPosition with Popover. The hook positions the popover
|
|
158
159
|
// relative to the trigger element via CSS Anchor Positioning (with JS fallback).
|
|
159
160
|
// Use ctx.popoverRef when inside the compound (so the trigger can also
|
|
@@ -102,7 +102,7 @@ function createToggleScheduler() {
|
|
|
102
102
|
newState: newState
|
|
103
103
|
});
|
|
104
104
|
|
|
105
|
-
// Task queue (setTimeout)
|
|
105
|
+
// Task queue (setTimeout) - browser fires toggle after microtasks drain, not during
|
|
106
106
|
setTimeout(function () {
|
|
107
107
|
var entry = pending.get(element);
|
|
108
108
|
if (!entry) {
|
|
@@ -172,7 +172,7 @@ function createDialogToggleScheduler() {
|
|
|
172
172
|
};
|
|
173
173
|
}
|
|
174
174
|
|
|
175
|
-
//
|
|
175
|
+
// Popover API
|
|
176
176
|
// Spec: https://html.spec.whatwg.org/multipage/popover.html
|
|
177
177
|
|
|
178
178
|
// `popover` attribute valid values. Empty / "auto" -> "auto"; unknown -> "manual".
|
|
@@ -535,7 +535,7 @@ if (typeof HTMLElement !== 'undefined') {
|
|
|
535
535
|
if (isPopoverOpen({
|
|
536
536
|
element: this
|
|
537
537
|
})) {
|
|
538
|
-
return; // already showing
|
|
538
|
+
return; // already showing - no-op
|
|
539
539
|
}
|
|
540
540
|
|
|
541
541
|
// sync, cancelable on show only
|
|
@@ -715,7 +715,7 @@ if (typeof HTMLElement !== 'undefined') {
|
|
|
715
715
|
}
|
|
716
716
|
}
|
|
717
717
|
|
|
718
|
-
//
|
|
718
|
+
// HTMLDialogElement
|
|
719
719
|
// Spec: https://html.spec.whatwg.org/multipage/interactive-elements.html#the-dialog-element
|
|
720
720
|
|
|
721
721
|
if (typeof HTMLDialogElement !== 'undefined') {
|
|
@@ -730,7 +730,7 @@ if (typeof HTMLDialogElement !== 'undefined') {
|
|
|
730
730
|
}
|
|
731
731
|
if (this.hasAttribute('open')) {
|
|
732
732
|
if (this._isModal) {
|
|
733
|
-
return; // already modal
|
|
733
|
+
return; // already modal - no-op
|
|
734
734
|
}
|
|
735
735
|
throw new DOMException("Failed to execute 'showModal' on 'HTMLDialogElement': ".concat(describeElement({
|
|
736
736
|
element: this
|
|
@@ -754,7 +754,7 @@ if (typeof HTMLDialogElement !== 'undefined') {
|
|
|
754
754
|
}
|
|
755
755
|
if (typeof proto.show !== 'function') {
|
|
756
756
|
proto.show = function show() {
|
|
757
|
-
// Browser does not throw for disconnected elements on show
|
|
757
|
+
// Browser does not throw for disconnected elements on show - just no-op
|
|
758
758
|
if (!this.isConnected || this.hasAttribute('open')) {
|
|
759
759
|
return;
|
|
760
760
|
}
|
|
@@ -777,10 +777,10 @@ if (typeof HTMLDialogElement !== 'undefined') {
|
|
|
777
777
|
if (typeof proto.close !== 'function') {
|
|
778
778
|
proto.close = function close(returnValue) {
|
|
779
779
|
if (!this.hasAttribute('open')) {
|
|
780
|
-
return; // already closed
|
|
780
|
+
return; // already closed - no-op
|
|
781
781
|
}
|
|
782
782
|
|
|
783
|
-
// Sync beforetoggle (not cancelable)
|
|
783
|
+
// Sync beforetoggle (not cancelable) - matches browser behavior
|
|
784
784
|
fireToggleEvent({
|
|
785
785
|
element: this,
|
|
786
786
|
type: 'beforetoggle',
|
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
*
|
|
6
6
|
* jest-dom's `toBeVisible()` does not know about the Popover API. In real
|
|
7
7
|
* browsers the UA stylesheet hides `[popover]` with `display: none`, but
|
|
8
|
-
* jsdom has no such stylesheet
|
|
8
|
+
* jsdom has no such stylesheet - so closed popovers incorrectly appear visible.
|
|
9
9
|
*
|
|
10
10
|
* Raw jest-dom results in jsdom:
|
|
11
11
|
*
|
|
12
|
-
* closed popover / child → true (WRONG
|
|
12
|
+
* closed popover / child → true (WRONG - should be false)
|
|
13
13
|
* open popover / child → true (correct)
|
|
14
|
-
* closed dialog / child → false (correct
|
|
14
|
+
* closed dialog / child → false (correct - jsdom natively hides <dialog>)
|
|
15
15
|
* open dialog / child → true (correct)
|
|
16
16
|
*
|
|
17
17
|
* We correct both false positives and false negatives:
|
|
@@ -62,7 +62,7 @@ expect.extend({
|
|
|
62
62
|
var originalResult = originalToBeVisible.call(this, element);
|
|
63
63
|
var topLayerState = nearestTopLayerState(element);
|
|
64
64
|
if (originalResult.pass) {
|
|
65
|
-
// Original says visible
|
|
65
|
+
// Original says visible - override if nearest top-layer host is closed.
|
|
66
66
|
if (topLayerState === 'closed') {
|
|
67
67
|
return {
|
|
68
68
|
pass: false,
|
|
@@ -74,7 +74,7 @@ expect.extend({
|
|
|
74
74
|
return originalResult;
|
|
75
75
|
}
|
|
76
76
|
|
|
77
|
-
// Original says not visible
|
|
77
|
+
// Original says not visible - override if nearest top-layer host is open.
|
|
78
78
|
// jsdom may hide [popover] elements even when they are logically open.
|
|
79
79
|
if (topLayerState === 'open') {
|
|
80
80
|
return {
|
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
var menuScope = '[role="menu"]';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Recursively walks from `node` toward `container`, returning `true` when
|
|
5
|
+
* `container` is reached without crossing another `role="menu"` ancestor.
|
|
6
|
+
*
|
|
7
|
+
* Used by `isAtCurrentMenuLevel` (pattern 2) to determine if the
|
|
8
|
+
* `closestMenu` is owned by the wrapper container directly. Recursion
|
|
9
|
+
* avoids a mutable `let parent` walk and keeps the function body linear.
|
|
10
|
+
*/
|
|
11
|
+
function reachesContainerWithoutNestedMenu(node, container) {
|
|
12
|
+
if (!node || node === container) {
|
|
13
|
+
return node === container;
|
|
14
|
+
}
|
|
15
|
+
if (node.getAttribute('role') === 'menu') {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
return reachesContainerWithoutNestedMenu(node.parentElement, container);
|
|
19
|
+
}
|
|
20
|
+
|
|
3
21
|
/**
|
|
4
22
|
* Returns true if the element belongs to the current menu level of the
|
|
5
23
|
* container, i.e. it is NOT inside a nested `role="menu"` sub-container.
|
|
@@ -66,16 +84,5 @@ export function isAtCurrentMenuLevel(element, container) {
|
|
|
66
84
|
|
|
67
85
|
// Walk up from the closest menu to see if it is "owned" by this
|
|
68
86
|
// container without passing through another role="menu" first.
|
|
69
|
-
|
|
70
|
-
while (parent && parent !== container) {
|
|
71
|
-
if (parent.getAttribute('role') === 'menu') {
|
|
72
|
-
// There is a parent menu between the closest menu and the
|
|
73
|
-
// container, so the element is in a nested sub-menu.
|
|
74
|
-
return false;
|
|
75
|
-
}
|
|
76
|
-
parent = parent.parentElement;
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
// The closest menu is directly inside the container (no nesting).
|
|
80
|
-
return parent === container;
|
|
87
|
+
return reachesContainerWithoutNestedMenu(closestMenu.parentElement, container);
|
|
81
88
|
}
|
|
@@ -2,7 +2,9 @@ import { useCallback, useEffect } from 'react';
|
|
|
2
2
|
import { bind } from 'bind-event-listener';
|
|
3
3
|
import { getDocument } from '@atlaskit/browser-apis';
|
|
4
4
|
import { KEY_DOWN, KEY_END, KEY_HOME, KEY_TAB, KEY_UP } from '@atlaskit/ds-lib/keycodes';
|
|
5
|
-
import { getFirstFocusable
|
|
5
|
+
import { getFirstFocusable } from '../focus/get-first-focusable';
|
|
6
|
+
import { getLastFocusable } from '../focus/get-last-focusable';
|
|
7
|
+
import { getNextFocusable } from '../focus/get-next-focusable';
|
|
6
8
|
var menuScope = '[role="menu"]';
|
|
7
9
|
|
|
8
10
|
/**
|
|
@@ -9,7 +9,7 @@ import { bind } from 'bind-event-listener';
|
|
|
9
9
|
* **No stacking awareness:** This hook does not track a popover stack.
|
|
10
10
|
* If multiple manual popovers are open and all use this hook, a single
|
|
11
11
|
* Escape press or outside click will dismiss **all of them simultaneously**.
|
|
12
|
-
* This is by design
|
|
12
|
+
* This is by design - the hook is intentionally simple for cases where
|
|
13
13
|
* only one manual popover is open at a time.
|
|
14
14
|
*
|
|
15
15
|
* For stacked/nested popovers that should dismiss one-at-a-time, use
|
|
@@ -46,7 +46,7 @@ export function useSimpleLightDismiss(_ref) {
|
|
|
46
46
|
// (trigger onClick → setIsOpen(true) → React render → useEffect).
|
|
47
47
|
// By the time this effect runs, the opening click has finished
|
|
48
48
|
// bubbling. A capture-phase listener added now cannot retroactively
|
|
49
|
-
// fire for that event
|
|
49
|
+
// fire for that event - it only fires for *future* clicks.
|
|
50
50
|
//
|
|
51
51
|
// This avoids the need for timestamp guards or deferred binding.
|
|
52
52
|
// eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- binding to document for light dismiss
|
|
@@ -58,7 +58,7 @@ export function useSimpleLightDismiss(_ref) {
|
|
|
58
58
|
return;
|
|
59
59
|
}
|
|
60
60
|
|
|
61
|
-
// If the click target is inside the popover,
|
|
61
|
+
// If the click target is inside the popover, do not dismiss.
|
|
62
62
|
if (event.target instanceof Node && el.contains(event.target)) {
|
|
63
63
|
return;
|
|
64
64
|
}
|
|
@@ -3,7 +3,7 @@ import type { TDialogCloseReason } from './types';
|
|
|
3
3
|
* Creates a synthetic DOM event from a `TDialogCloseReason`.
|
|
4
4
|
*
|
|
5
5
|
* Useful when bridging the Dialog primitive's `onClose({ reason })` callback
|
|
6
|
-
* to a legacy API that expects a `KeyboardEvent` or `MouseEvent`
|
|
6
|
+
* to a legacy API that expects a `KeyboardEvent` or `MouseEvent` - for example,
|
|
7
7
|
* `@atlaskit/modal-dialog`'s `onClose(event, analyticsEvent)` contract.
|
|
8
8
|
*
|
|
9
9
|
* - `'escape'` → `KeyboardEvent('keydown', { key: 'Escape' })`
|
|
@@ -49,6 +49,14 @@ type TDialogBaseProps = {
|
|
|
49
49
|
* Additional inline styles applied to the `<dialog>` element.
|
|
50
50
|
*
|
|
51
51
|
* Use for custom width, height, transform, or other overrides.
|
|
52
|
+
*
|
|
53
|
+
* Rule deviation: the house rules ban unbounded `style` props on
|
|
54
|
+
* components. `Dialog` is a low-level primitive that intentionally has
|
|
55
|
+
* no visual opinions of its own; consumers such as `@atlaskit/modal-dialog`
|
|
56
|
+
* must be able to set width, height, and transforms on the native
|
|
57
|
+
* `<dialog>` element. Removing this prop would be a breaking change
|
|
58
|
+
* and is tracked separately. Keep until an xcss-based replacement
|
|
59
|
+
* exists on the primitive.
|
|
52
60
|
*/
|
|
53
61
|
style?: CSSProperties;
|
|
54
62
|
/**
|
|
@@ -1,2 +1,4 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export
|
|
1
|
+
export type { TFocusableFilter } from '../focus/types';
|
|
2
|
+
export { getFirstFocusable } from '../focus/get-first-focusable';
|
|
3
|
+
export { getLastFocusable } from '../focus/get-last-focusable';
|
|
4
|
+
export { getNextFocusable } from '../focus/get-next-focusable';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { useAnchorPositionAtPoint, type TAnchorPoint, } from '../internal/use-anchor-position-at-point';
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { TFocusableFilter } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Returns the first focusable element within the container.
|
|
4
|
+
*/
|
|
5
|
+
export declare function getFirstFocusable({ container, filter, }: {
|
|
6
|
+
container: HTMLElement;
|
|
7
|
+
filter?: TFocusableFilter;
|
|
8
|
+
}): HTMLElement | null;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { TFocusableFilter } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Returns all focusable HTMLElements within the container, optionally filtered.
|
|
4
|
+
*
|
|
5
|
+
* Focusables that belong to a nested top-layer scope (a `[popover]` or
|
|
6
|
+
* `<dialog>` descendant of the container) are excluded - those elements
|
|
7
|
+
* are owned by the inner layer's focus management. The container itself
|
|
8
|
+
* is allowed to be a popover/dialog; only nested ones are filtered.
|
|
9
|
+
*/
|
|
10
|
+
export declare function getFocusables({ container, filter, }: {
|
|
11
|
+
container: HTMLElement;
|
|
12
|
+
filter?: TFocusableFilter;
|
|
13
|
+
}): HTMLElement[];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { TFocusableFilter } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Returns the last focusable element within the container.
|
|
4
|
+
*/
|
|
5
|
+
export declare function getLastFocusable({ container, filter, }: {
|
|
6
|
+
container: HTMLElement;
|
|
7
|
+
filter?: TFocusableFilter;
|
|
8
|
+
}): HTMLElement | null;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns the next focusable element in the given direction relative to the
|
|
3
|
+
* currently focused element within the container. Wraps around at both ends.
|
|
4
|
+
*
|
|
5
|
+
* Returns `null` if there is no focused element within the container or if
|
|
6
|
+
* the focused element is not in the list of focusable elements.
|
|
7
|
+
*/
|
|
8
|
+
import type { TFocusableFilter } from './types';
|
|
9
|
+
export declare function getNextFocusable({ container, direction, filter, }: {
|
|
10
|
+
container: HTMLElement;
|
|
11
|
+
direction: 'forwards' | 'backwards';
|
|
12
|
+
filter?: TFocusableFilter;
|
|
13
|
+
}): HTMLElement | null;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns true when `element` and `container` resolve to the same nearest
|
|
3
|
+
* top-layer host (or both resolve to `null`, meaning the document layer).
|
|
4
|
+
*/
|
|
5
|
+
export declare function isInSameLayer({ element, container, }: {
|
|
6
|
+
element: HTMLElement;
|
|
7
|
+
container: HTMLElement;
|
|
8
|
+
}): boolean;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns `true` when `document.activeElement` is inside a nested top-layer
|
|
3
|
+
* descendant of `container` (a `[popover]`, `<dialog>`, `[role="dialog"]` or
|
|
4
|
+
* `[role="alertdialog"]` that is itself a descendant of `container`).
|
|
5
|
+
*/
|
|
6
|
+
export declare function isNestedLayerFocused({ container }: {
|
|
7
|
+
container: HTMLElement;
|
|
8
|
+
}): boolean;
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*
|
|
6
6
|
* The result is cached after the first call via `once`. This avoids
|
|
7
7
|
* calling `matchMedia` on every render. The trade-off is that if a user
|
|
8
|
-
* toggles the OS reduced-motion setting mid-session, the change
|
|
8
|
+
* toggles the OS reduced-motion setting mid-session, the change will not
|
|
9
9
|
* take effect until the next page load. This is acceptable because
|
|
10
10
|
* toggling this system-level preference mid-session is extremely rare,
|
|
11
11
|
* and a page refresh is a reasonable expectation for system accessibility
|
|
@@ -30,8 +30,8 @@ export type TPlacement = {
|
|
|
30
30
|
* CSS length string (e.g. `token('space.100')`).
|
|
31
31
|
*
|
|
32
32
|
* The two offset axes are named for clarity at the call site:
|
|
33
|
-
* - `gap`
|
|
34
|
-
* - `crossAxisShift`
|
|
33
|
+
* - `gap` - distance away from the trigger along the placement axis
|
|
34
|
+
* - `crossAxisShift` - nudge along the trigger edge (perpendicular to the placement axis)
|
|
35
35
|
*/
|
|
36
36
|
export type TPlacementOptions = {
|
|
37
37
|
axis?: 'block' | 'inline';
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { TAriaHasPopupValue, TRoleRequiringAccessibleName, TRoleWithImplicitName } from './role-types';
|
|
2
|
+
/**
|
|
3
|
+
* Maps a popover content role to the correct `aria-haspopup` value
|
|
4
|
+
* for its trigger element.
|
|
5
|
+
*
|
|
6
|
+
* Returns `undefined` for roles that are not popups in the ARIA sense
|
|
7
|
+
* (`tooltip`, `note`, `status`, `alert`, `log`). Triggers for those roles
|
|
8
|
+
* should not announce a popup at all - emitting `aria-haspopup="dialog"`
|
|
9
|
+
* on a tooltip trigger would mislead assistive technology.
|
|
10
|
+
*/
|
|
11
|
+
export declare function roleToAriaHasPopup({ role, }: {
|
|
12
|
+
role: TRoleRequiringAccessibleName | TRoleWithImplicitName | undefined;
|
|
13
|
+
}): TAriaHasPopupValue;
|
|
@@ -61,23 +61,4 @@ export type TAriaRoleOptional = ({
|
|
|
61
61
|
} & TAccessibleNameRequired) | ({
|
|
62
62
|
role?: TRoleWithImplicitName;
|
|
63
63
|
} & TAccessibleNameOptional);
|
|
64
|
-
/**
|
|
65
|
-
* Maps a popover content role to the correct `aria-haspopup` value
|
|
66
|
-
* for its trigger element.
|
|
67
|
-
*
|
|
68
|
-
* Returns `undefined` for roles that are not popups in the ARIA sense
|
|
69
|
-
* (`tooltip`, `note`, `status`, `alert`, `log`). Triggers for those roles
|
|
70
|
-
* should not announce a popup at all - emitting `aria-haspopup="dialog"`
|
|
71
|
-
* on a tooltip trigger would mislead assistive technology.
|
|
72
|
-
*/
|
|
73
|
-
export declare function roleToAriaHasPopup({ role, }: {
|
|
74
|
-
role: TRoleRequiringAccessibleName | TRoleWithImplicitName | undefined;
|
|
75
|
-
}): TAriaHasPopupValue;
|
|
76
|
-
/**
|
|
77
|
-
* Returns `true` when the given popover role moves focus into the popover
|
|
78
|
-
* on open, and `false` otherwise (including when `role` is `undefined`).
|
|
79
|
-
*/
|
|
80
|
-
export declare function shouldFocusIntoPopover({ role, }: {
|
|
81
|
-
role: TRoleRequiringAccessibleName | TRoleWithImplicitName | undefined;
|
|
82
|
-
}): boolean;
|
|
83
64
|
export {};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { TRoleRequiringAccessibleName, TRoleWithImplicitName } from './role-types';
|
|
2
|
+
/**
|
|
3
|
+
* Returns `true` when the given popover role moves focus into the popover
|
|
4
|
+
* on open, and `false` otherwise (including when `role` is `undefined`).
|
|
5
|
+
*/
|
|
6
|
+
export declare function shouldFocusIntoPopover({ role, }: {
|
|
7
|
+
role: TRoleRequiringAccessibleName | TRoleWithImplicitName | undefined;
|
|
8
|
+
}): boolean;
|
|
@@ -2,21 +2,21 @@ import { type ForwardRefExoticComponent, type ReactNode, type RefAttributes } fr
|
|
|
2
2
|
/**
|
|
3
3
|
* Extra DOM/event props are passed through to the cloned child.
|
|
4
4
|
*/
|
|
5
|
-
export type
|
|
5
|
+
export type TSlotProps = {
|
|
6
6
|
children: ReactNode;
|
|
7
7
|
} & Record<string, unknown>;
|
|
8
8
|
/**
|
|
9
9
|
* Merges props (including ref) onto a single React element child.
|
|
10
10
|
*
|
|
11
11
|
* A safer alternative to raw `cloneElement` that:
|
|
12
|
-
* 1. Guards with `isValidElement`
|
|
12
|
+
* 1. Guards with `isValidElement` - non-element children (strings,
|
|
13
13
|
* fragments, null) are returned as-is instead of crashing.
|
|
14
14
|
* 2. Merges refs via `mergeRefs` so both the caller's ref and the
|
|
15
15
|
* child's existing ref are honoured.
|
|
16
16
|
* 3. Spreads any additional props (ARIA attributes, event handlers, etc.)
|
|
17
17
|
* onto the child element.
|
|
18
18
|
*
|
|
19
|
-
* Event handlers (e.g. `onClick`) are **not** auto-merged
|
|
19
|
+
* Event handlers (e.g. `onClick`) are **not** auto-merged - the caller's
|
|
20
20
|
* handler replaces the child's. Compose handlers before passing them in.
|
|
21
21
|
*
|
|
22
22
|
* @example
|
|
@@ -26,4 +26,4 @@ export type SlotProps = {
|
|
|
26
26
|
* </Slot>
|
|
27
27
|
* ```
|
|
28
28
|
*/
|
|
29
|
-
export declare const Slot: ForwardRefExoticComponent<
|
|
29
|
+
export declare const Slot: ForwardRefExoticComponent<TSlotProps & RefAttributes<HTMLElement>>;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { type RefObject } from 'react';
|
|
2
|
+
import { type TPlacementOptions } from './resolve-placement';
|
|
3
|
+
/**
|
|
4
|
+
* A point in viewport coordinates (CSS pixels) at which the synthetic
|
|
5
|
+
* anchor should be placed.
|
|
6
|
+
*
|
|
7
|
+
* Axis-named (`x`/`y`) rather than edge-named (`left`/`top`) so the
|
|
8
|
+
* shape is unambiguous in RTL writing modes — there is no ambiguity
|
|
9
|
+
* about whether a coordinate is logical (`inline-start`/`block-start`)
|
|
10
|
+
* or physical (`left`/`top`). Viewport coordinates are always
|
|
11
|
+
* physical, so we name them with the physical axis labels.
|
|
12
|
+
*/
|
|
13
|
+
export type TAnchorPoint = {
|
|
14
|
+
x: number;
|
|
15
|
+
y: number;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Positions a popover at a consumer-supplied viewport coordinate using a
|
|
19
|
+
* hidden synthetic anchor.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```tsx
|
|
23
|
+
* function PointPositionedPopover({ popoverRef, placement, mousePos }) {
|
|
24
|
+
* useAnchorPositionAtPoint({
|
|
25
|
+
* popoverRef,
|
|
26
|
+
* placement,
|
|
27
|
+
* isEnabled: Boolean(mousePos),
|
|
28
|
+
* getPoint: () => {
|
|
29
|
+
* if (!mousePos) return null;
|
|
30
|
+
* return { x: mousePos.clientX, y: mousePos.clientY };
|
|
31
|
+
* },
|
|
32
|
+
* });
|
|
33
|
+
* return <Popover ref={popoverRef}>...</Popover>;
|
|
34
|
+
* }
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
export declare function useAnchorPositionAtPoint({ popoverRef, placement, getPoint, isEnabled, }: {
|
|
38
|
+
/**
|
|
39
|
+
* Element being positioned. Passed to `useAnchorPosition`.
|
|
40
|
+
*/
|
|
41
|
+
popoverRef: RefObject<HTMLElement | null>;
|
|
42
|
+
/**
|
|
43
|
+
* Where the popover sits relative to the anchor.
|
|
44
|
+
*/
|
|
45
|
+
placement: TPlacementOptions;
|
|
46
|
+
/**
|
|
47
|
+
* Lazy callback returning the viewport coordinate to anchor at.
|
|
48
|
+
* Called once per activation (every `isEnabled: false → true`
|
|
49
|
+
* transition); the result is latched and not re-read.
|
|
50
|
+
*
|
|
51
|
+
* Return `null` to signal "no point yet" — the hook stays in a
|
|
52
|
+
* no-DOM state so another positioning strategy can own the popover.
|
|
53
|
+
*
|
|
54
|
+
* Read from a ref, so it does not need to be memoized.
|
|
55
|
+
*/
|
|
56
|
+
getPoint: () => TAnchorPoint | null;
|
|
57
|
+
/**
|
|
58
|
+
* When `false`, the hook is a no-op: no synthetic anchor is created
|
|
59
|
+
* and no positioning is applied. Defaults to `true`.
|
|
60
|
+
*/
|
|
61
|
+
isEnabled?: boolean;
|
|
62
|
+
}): void;
|