@atlaskit/top-layer 0.1.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 +44 -0
- package/README.md +151 -0
- package/animations/package.json +17 -0
- package/arrow/package.json +17 -0
- package/create-close-event/package.json +17 -0
- package/dialog/package.json +17 -0
- package/dialog-scroll-lock/package.json +17 -0
- package/dist/cjs/animations/presets.js +199 -0
- package/dist/cjs/animations/types.js +5 -0
- package/dist/cjs/arrow/index.js +130 -0
- package/dist/cjs/arrow/types.js +5 -0
- package/dist/cjs/dialog/create-close-event.js +39 -0
- package/dist/cjs/dialog/dialog-content.compiled.css +14 -0
- package/dist/cjs/dialog/dialog-content.js +144 -0
- package/dist/cjs/dialog/index.js +19 -0
- package/dist/cjs/dialog/types.js +5 -0
- package/dist/cjs/dialog-scroll-lock/index.js +46 -0
- package/dist/cjs/entry-points/animations.js +36 -0
- package/dist/cjs/entry-points/arrow.js +12 -0
- package/dist/cjs/entry-points/create-close-event.js +19 -0
- package/dist/cjs/entry-points/dialog-scroll-lock.js +12 -0
- package/dist/cjs/entry-points/dialog.js +12 -0
- package/dist/cjs/entry-points/focus.js +24 -0
- package/dist/cjs/entry-points/placement-map.js +18 -0
- package/dist/cjs/entry-points/popover.js +12 -0
- package/dist/cjs/entry-points/popup-surface.js +12 -0
- package/dist/cjs/entry-points/popup.js +12 -0
- package/dist/cjs/entry-points/use-anchor-position.js +12 -0
- package/dist/cjs/entry-points/use-arrow-navigation.js +18 -0
- package/dist/cjs/entry-points/use-simple-light-dismiss.js +12 -0
- package/dist/cjs/focus/focus.js +115 -0
- package/dist/cjs/focus/index.js +24 -0
- package/dist/cjs/index.js +8 -0
- package/dist/cjs/internal/anchor-positioning-fallback.js +154 -0
- package/dist/cjs/internal/combine.js +29 -0
- package/dist/cjs/internal/ensure-preset-styles.js +34 -0
- package/dist/cjs/internal/reduced-motion.js +27 -0
- package/dist/cjs/internal/resolve-placement.js +24 -0
- package/dist/cjs/internal/role-types.js +66 -0
- package/dist/cjs/internal/set-style.js +42 -0
- package/dist/cjs/internal/slot.js +65 -0
- package/dist/cjs/internal/use-anchor-positioning.js +336 -0
- package/dist/cjs/internal/use-animated-visibility.js +169 -0
- package/dist/cjs/internal/use-animation-preset.js +24 -0
- package/dist/cjs/internal/use-focus-wrap.js +94 -0
- package/dist/cjs/internal/use-initial-focus.js +112 -0
- package/dist/cjs/internal/use-preset-styles.js +27 -0
- package/dist/cjs/placement-map/index.js +147 -0
- package/dist/cjs/popover/create-close-event.js +44 -0
- package/dist/cjs/popover/index.js +19 -0
- package/dist/cjs/popover/popover.compiled.css +13 -0
- package/dist/cjs/popover/popover.js +251 -0
- package/dist/cjs/popover/types.js +5 -0
- package/dist/cjs/popup/index.js +37 -0
- package/dist/cjs/popup/popup-content.js +201 -0
- package/dist/cjs/popup/popup-context.js +42 -0
- package/dist/cjs/popup/popup-surface.compiled.css +5 -0
- package/dist/cjs/popup/popup-surface.js +30 -0
- package/dist/cjs/popup/popup-trigger-function.js +74 -0
- package/dist/cjs/popup/popup-trigger.js +82 -0
- package/dist/cjs/popup/popup.js +70 -0
- package/dist/cjs/popup/types.js +5 -0
- package/dist/cjs/use-arrow-navigation/index.js +18 -0
- package/dist/cjs/use-arrow-navigation/use-arrow-navigation.js +245 -0
- package/dist/cjs/use-simple-light-dismiss/index.js +84 -0
- package/dist/es2019/animations/presets.js +375 -0
- package/dist/es2019/animations/types.js +1 -0
- package/dist/es2019/arrow/index.js +249 -0
- package/dist/es2019/arrow/types.js +1 -0
- package/dist/es2019/dialog/create-close-event.js +34 -0
- package/dist/es2019/dialog/dialog-content.compiled.css +14 -0
- package/dist/es2019/dialog/dialog-content.js +138 -0
- package/dist/es2019/dialog/index.js +2 -0
- package/dist/es2019/dialog/types.js +1 -0
- package/dist/es2019/dialog-scroll-lock/index.js +41 -0
- package/dist/es2019/entry-points/animations.js +1 -0
- package/dist/es2019/entry-points/arrow.js +1 -0
- package/dist/es2019/entry-points/create-close-event.js +2 -0
- package/dist/es2019/entry-points/dialog-scroll-lock.js +1 -0
- package/dist/es2019/entry-points/dialog.js +1 -0
- package/dist/es2019/entry-points/focus.js +1 -0
- package/dist/es2019/entry-points/placement-map.js +1 -0
- package/dist/es2019/entry-points/popover.js +1 -0
- package/dist/es2019/entry-points/popup-surface.js +1 -0
- package/dist/es2019/entry-points/popup.js +1 -0
- package/dist/es2019/entry-points/use-anchor-position.js +1 -0
- package/dist/es2019/entry-points/use-arrow-navigation.js +1 -0
- package/dist/es2019/entry-points/use-simple-light-dismiss.js +1 -0
- package/dist/es2019/focus/focus.js +107 -0
- package/dist/es2019/focus/index.js +1 -0
- package/dist/es2019/index.js +7 -0
- package/dist/es2019/internal/anchor-positioning-fallback.js +153 -0
- package/dist/es2019/internal/combine.js +18 -0
- package/dist/es2019/internal/ensure-preset-styles.js +29 -0
- package/dist/es2019/internal/reduced-motion.js +21 -0
- package/dist/es2019/internal/resolve-placement.js +19 -0
- package/dist/es2019/internal/role-types.js +61 -0
- package/dist/es2019/internal/set-style.js +39 -0
- package/dist/es2019/internal/slot.js +57 -0
- package/dist/es2019/internal/use-anchor-positioning.js +330 -0
- package/dist/es2019/internal/use-animated-visibility.js +159 -0
- package/dist/es2019/internal/use-animation-preset.js +18 -0
- package/dist/es2019/internal/use-focus-wrap.js +90 -0
- package/dist/es2019/internal/use-initial-focus.js +109 -0
- package/dist/es2019/internal/use-preset-styles.js +22 -0
- package/dist/es2019/placement-map/index.js +142 -0
- package/dist/es2019/popover/create-close-event.js +39 -0
- package/dist/es2019/popover/index.js +2 -0
- package/dist/es2019/popover/popover.compiled.css +13 -0
- package/dist/es2019/popover/popover.js +240 -0
- package/dist/es2019/popover/types.js +1 -0
- package/dist/es2019/popup/index.js +33 -0
- package/dist/es2019/popup/popup-content.js +192 -0
- package/dist/es2019/popup/popup-context.js +34 -0
- package/dist/es2019/popup/popup-surface.compiled.css +5 -0
- package/dist/es2019/popup/popup-surface.js +24 -0
- package/dist/es2019/popup/popup-trigger-function.js +69 -0
- package/dist/es2019/popup/popup-trigger.js +76 -0
- package/dist/es2019/popup/popup.js +56 -0
- package/dist/es2019/popup/types.js +1 -0
- package/dist/es2019/use-arrow-navigation/index.js +1 -0
- package/dist/es2019/use-arrow-navigation/use-arrow-navigation.js +238 -0
- package/dist/es2019/use-simple-light-dismiss/index.js +79 -0
- package/dist/esm/animations/presets.js +190 -0
- package/dist/esm/animations/types.js +1 -0
- package/dist/esm/arrow/index.js +123 -0
- package/dist/esm/arrow/types.js +1 -0
- package/dist/esm/dialog/create-close-event.js +33 -0
- package/dist/esm/dialog/dialog-content.compiled.css +14 -0
- package/dist/esm/dialog/dialog-content.js +135 -0
- package/dist/esm/dialog/index.js +2 -0
- package/dist/esm/dialog/types.js +1 -0
- package/dist/esm/dialog-scroll-lock/index.js +41 -0
- package/dist/esm/entry-points/animations.js +1 -0
- package/dist/esm/entry-points/arrow.js +1 -0
- package/dist/esm/entry-points/create-close-event.js +2 -0
- package/dist/esm/entry-points/dialog-scroll-lock.js +1 -0
- package/dist/esm/entry-points/dialog.js +1 -0
- package/dist/esm/entry-points/focus.js +1 -0
- package/dist/esm/entry-points/placement-map.js +1 -0
- package/dist/esm/entry-points/popover.js +1 -0
- package/dist/esm/entry-points/popup-surface.js +1 -0
- package/dist/esm/entry-points/popup.js +1 -0
- package/dist/esm/entry-points/use-anchor-position.js +1 -0
- package/dist/esm/entry-points/use-arrow-navigation.js +1 -0
- package/dist/esm/entry-points/use-simple-light-dismiss.js +1 -0
- package/dist/esm/focus/focus.js +107 -0
- package/dist/esm/focus/index.js +1 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/internal/anchor-positioning-fallback.js +147 -0
- package/dist/esm/internal/combine.js +23 -0
- package/dist/esm/internal/ensure-preset-styles.js +28 -0
- package/dist/esm/internal/reduced-motion.js +21 -0
- package/dist/esm/internal/resolve-placement.js +18 -0
- package/dist/esm/internal/role-types.js +60 -0
- package/dist/esm/internal/set-style.js +36 -0
- package/dist/esm/internal/slot.js +59 -0
- package/dist/esm/internal/use-anchor-positioning.js +323 -0
- package/dist/esm/internal/use-animated-visibility.js +162 -0
- package/dist/esm/internal/use-animation-preset.js +18 -0
- package/dist/esm/internal/use-focus-wrap.js +89 -0
- package/dist/esm/internal/use-initial-focus.js +107 -0
- package/dist/esm/internal/use-preset-styles.js +21 -0
- package/dist/esm/placement-map/index.js +141 -0
- package/dist/esm/popover/create-close-event.js +38 -0
- package/dist/esm/popover/index.js +2 -0
- package/dist/esm/popover/popover.compiled.css +13 -0
- package/dist/esm/popover/popover.js +242 -0
- package/dist/esm/popover/types.js +1 -0
- package/dist/esm/popup/index.js +33 -0
- package/dist/esm/popup/popup-content.js +192 -0
- package/dist/esm/popup/popup-context.js +34 -0
- package/dist/esm/popup/popup-surface.compiled.css +5 -0
- package/dist/esm/popup/popup-surface.js +23 -0
- package/dist/esm/popup/popup-trigger-function.js +69 -0
- package/dist/esm/popup/popup-trigger.js +74 -0
- package/dist/esm/popup/popup.js +61 -0
- package/dist/esm/popup/types.js +1 -0
- package/dist/esm/use-arrow-navigation/index.js +1 -0
- package/dist/esm/use-arrow-navigation/use-arrow-navigation.js +238 -0
- package/dist/esm/use-simple-light-dismiss/index.js +78 -0
- package/dist/types/animations/presets.d.ts +94 -0
- package/dist/types/animations/types.d.ts +42 -0
- package/dist/types/arrow/index.d.ts +24 -0
- package/dist/types/arrow/types.d.ts +29 -0
- package/dist/types/dialog/create-close-event.d.ts +24 -0
- package/dist/types/dialog/dialog-content.d.ts +20 -0
- package/dist/types/dialog/index.d.ts +3 -0
- package/dist/types/dialog/types.d.ts +92 -0
- package/dist/types/dialog-scroll-lock/index.d.ts +24 -0
- package/dist/types/entry-points/animations.d.ts +2 -0
- package/dist/types/entry-points/arrow.d.ts +2 -0
- package/dist/types/entry-points/create-close-event.d.ts +4 -0
- package/dist/types/entry-points/dialog-scroll-lock.d.ts +1 -0
- package/dist/types/entry-points/dialog.d.ts +2 -0
- package/dist/types/entry-points/focus.d.ts +2 -0
- package/dist/types/entry-points/placement-map.d.ts +2 -0
- package/dist/types/entry-points/popover.d.ts +2 -0
- package/dist/types/entry-points/popup-surface.d.ts +2 -0
- package/dist/types/entry-points/popup.d.ts +2 -0
- package/dist/types/entry-points/use-anchor-position.d.ts +1 -0
- package/dist/types/entry-points/use-arrow-navigation.d.ts +2 -0
- package/dist/types/entry-points/use-simple-light-dismiss.d.ts +2 -0
- package/dist/types/focus/focus.d.ts +42 -0
- package/dist/types/focus/index.d.ts +2 -0
- package/dist/types/index.d.ts +0 -0
- package/dist/types/internal/anchor-positioning-fallback.d.ts +24 -0
- package/dist/types/internal/combine.d.ts +14 -0
- package/dist/types/internal/ensure-preset-styles.d.ts +6 -0
- package/dist/types/internal/reduced-motion.d.ts +14 -0
- package/dist/types/internal/resolve-placement.d.ts +16 -0
- package/dist/types/internal/role-types.d.ts +62 -0
- package/dist/types/internal/set-style.d.ts +28 -0
- package/dist/types/internal/slot.d.ts +29 -0
- package/dist/types/internal/use-anchor-positioning.d.ts +95 -0
- package/dist/types/internal/use-animated-visibility.d.ts +74 -0
- package/dist/types/internal/use-animation-preset.d.ts +11 -0
- package/dist/types/internal/use-focus-wrap.d.ts +20 -0
- package/dist/types/internal/use-initial-focus.d.ts +21 -0
- package/dist/types/internal/use-preset-styles.d.ts +15 -0
- package/dist/types/placement-map/index.d.ts +55 -0
- package/dist/types/popover/create-close-event.d.ts +26 -0
- package/dist/types/popover/index.d.ts +3 -0
- package/dist/types/popover/popover.d.ts +22 -0
- package/dist/types/popover/types.d.ts +153 -0
- package/dist/types/popup/index.d.ts +34 -0
- package/dist/types/popup/popup-content.d.ts +14 -0
- package/dist/types/popup/popup-context.d.ts +96 -0
- package/dist/types/popup/popup-surface.d.ts +16 -0
- package/dist/types/popup/popup-trigger-function.d.ts +108 -0
- package/dist/types/popup/popup-trigger.d.ts +23 -0
- package/dist/types/popup/popup.d.ts +14 -0
- package/dist/types/popup/types.d.ts +289 -0
- package/dist/types/use-arrow-navigation/index.d.ts +2 -0
- package/dist/types/use-arrow-navigation/use-arrow-navigation.d.ts +136 -0
- package/dist/types/use-simple-light-dismiss/index.d.ts +45 -0
- package/dist/types-ts4.5/animations/presets.d.ts +94 -0
- package/dist/types-ts4.5/animations/types.d.ts +42 -0
- package/dist/types-ts4.5/arrow/index.d.ts +24 -0
- package/dist/types-ts4.5/arrow/types.d.ts +29 -0
- package/dist/types-ts4.5/dialog/create-close-event.d.ts +24 -0
- package/dist/types-ts4.5/dialog/dialog-content.d.ts +20 -0
- package/dist/types-ts4.5/dialog/index.d.ts +3 -0
- package/dist/types-ts4.5/dialog/types.d.ts +92 -0
- package/dist/types-ts4.5/dialog-scroll-lock/index.d.ts +24 -0
- package/dist/types-ts4.5/entry-points/animations.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/arrow.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/create-close-event.d.ts +4 -0
- package/dist/types-ts4.5/entry-points/dialog-scroll-lock.d.ts +1 -0
- package/dist/types-ts4.5/entry-points/dialog.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/focus.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/placement-map.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/popover.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/popup-surface.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/popup.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/use-anchor-position.d.ts +1 -0
- package/dist/types-ts4.5/entry-points/use-arrow-navigation.d.ts +2 -0
- package/dist/types-ts4.5/entry-points/use-simple-light-dismiss.d.ts +2 -0
- package/dist/types-ts4.5/focus/focus.d.ts +42 -0
- package/dist/types-ts4.5/focus/index.d.ts +2 -0
- package/dist/types-ts4.5/index.d.ts +0 -0
- package/dist/types-ts4.5/internal/anchor-positioning-fallback.d.ts +24 -0
- package/dist/types-ts4.5/internal/combine.d.ts +14 -0
- package/dist/types-ts4.5/internal/ensure-preset-styles.d.ts +6 -0
- package/dist/types-ts4.5/internal/reduced-motion.d.ts +14 -0
- package/dist/types-ts4.5/internal/resolve-placement.d.ts +16 -0
- package/dist/types-ts4.5/internal/role-types.d.ts +62 -0
- package/dist/types-ts4.5/internal/set-style.d.ts +28 -0
- package/dist/types-ts4.5/internal/slot.d.ts +29 -0
- package/dist/types-ts4.5/internal/use-anchor-positioning.d.ts +95 -0
- package/dist/types-ts4.5/internal/use-animated-visibility.d.ts +74 -0
- package/dist/types-ts4.5/internal/use-animation-preset.d.ts +11 -0
- package/dist/types-ts4.5/internal/use-focus-wrap.d.ts +20 -0
- package/dist/types-ts4.5/internal/use-initial-focus.d.ts +21 -0
- package/dist/types-ts4.5/internal/use-preset-styles.d.ts +15 -0
- package/dist/types-ts4.5/placement-map/index.d.ts +55 -0
- package/dist/types-ts4.5/popover/create-close-event.d.ts +26 -0
- package/dist/types-ts4.5/popover/index.d.ts +3 -0
- package/dist/types-ts4.5/popover/popover.d.ts +22 -0
- package/dist/types-ts4.5/popover/types.d.ts +153 -0
- package/dist/types-ts4.5/popup/index.d.ts +34 -0
- package/dist/types-ts4.5/popup/popup-content.d.ts +14 -0
- package/dist/types-ts4.5/popup/popup-context.d.ts +96 -0
- package/dist/types-ts4.5/popup/popup-surface.d.ts +16 -0
- package/dist/types-ts4.5/popup/popup-trigger-function.d.ts +108 -0
- package/dist/types-ts4.5/popup/popup-trigger.d.ts +23 -0
- package/dist/types-ts4.5/popup/popup.d.ts +14 -0
- package/dist/types-ts4.5/popup/types.d.ts +289 -0
- package/dist/types-ts4.5/use-arrow-navigation/index.d.ts +2 -0
- package/dist/types-ts4.5/use-arrow-navigation/use-arrow-navigation.d.ts +136 -0
- package/dist/types-ts4.5/use-simple-light-dismiss/index.d.ts +45 -0
- package/focus/package.json +17 -0
- package/package.json +95 -0
- package/placement-map/package.json +17 -0
- package/popover/package.json +17 -0
- package/popup/package.json +17 -0
- package/popup-surface/package.json +17 -0
- package/use-anchor-position/package.json +17 -0
- package/use-arrow-navigation/package.json +17 -0
- package/use-simple-light-dismiss/package.json +17 -0
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
import { useCallback, useEffect } from 'react';
|
|
2
|
+
import { bind } from 'bind-event-listener';
|
|
3
|
+
import { getDocument } from '@atlaskit/browser-apis';
|
|
4
|
+
import { KEY_DOWN, KEY_END, KEY_HOME, KEY_TAB, KEY_UP } from '@atlaskit/ds-lib/keycodes';
|
|
5
|
+
import { getFirstFocusable, getLastFocusable, getNextFocusable } from '../focus';
|
|
6
|
+
var menuScope = '[role="menu"]';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Returns true if the element belongs to the current menu level of the
|
|
10
|
+
* container — i.e. it is NOT inside a nested `role="menu"` sub-container.
|
|
11
|
+
*
|
|
12
|
+
* Uses `element.closest('[role="menu"]')` to determine the nearest menu
|
|
13
|
+
* scope. If the nearest scope is the container's own `role="menu"` element,
|
|
14
|
+
* the element belongs to this level. If it's a different (nested) menu,
|
|
15
|
+
* the element belongs to a child level and should be excluded.
|
|
16
|
+
*
|
|
17
|
+
* Supports two container patterns:
|
|
18
|
+
*
|
|
19
|
+
* **1. Container has `role="menu"` directly** (preferred — used by avatar-group):
|
|
20
|
+
* ```
|
|
21
|
+
* <div ref={containerRef} role="menu">
|
|
22
|
+
* <button role="menuitem" /> ← isAtCurrentMenuLevel → true
|
|
23
|
+
* <div role="menu"> ← nested sub-menu
|
|
24
|
+
* <button role="menuitem" /> ← isAtCurrentMenuLevel → false
|
|
25
|
+
* </div>
|
|
26
|
+
* </div>
|
|
27
|
+
* ```
|
|
28
|
+
* Uses the simple check: `element.closest('[role="menu"]') === container`
|
|
29
|
+
*
|
|
30
|
+
* **2. Container is a wrapper without `role="menu"`** (used by dropdown-menu,
|
|
31
|
+
* where `MenuGroup` owns `role="menu"` but doesn't accept a ref):
|
|
32
|
+
* ```
|
|
33
|
+
* <div ref={containerRef}> ← wrapper (no role="menu")
|
|
34
|
+
* <MenuGroup role="menu">
|
|
35
|
+
* <button role="menuitem" /> ← isAtCurrentMenuLevel → true
|
|
36
|
+
* <div role="menu"> ← nested sub-menu
|
|
37
|
+
* <button role="menuitem" /> ← isAtCurrentMenuLevel → false
|
|
38
|
+
* </div>
|
|
39
|
+
* </MenuGroup>
|
|
40
|
+
* </div>
|
|
41
|
+
* ```
|
|
42
|
+
* Falls back to walking the DOM to check that the element's closest
|
|
43
|
+
* `role="menu"` is the container's own menu (not doubly nested).
|
|
44
|
+
*
|
|
45
|
+
* Ideally all consumers should use pattern 1 (place the ref directly on the
|
|
46
|
+
* `role="menu"` element). Pattern 2 exists because `@atlaskit/menu`'s
|
|
47
|
+
* `MenuGroup` does not currently accept a ref. If `MenuGroup` gains ref
|
|
48
|
+
* support in the future, dropdown-menu should switch to pattern 1 and the
|
|
49
|
+
* fallback path can be removed.
|
|
50
|
+
*
|
|
51
|
+
* Used both as a `TFocusableFilter` (to scope getNextFocusable etc.) and as
|
|
52
|
+
* a guard to prevent parent menu handlers from acting on events that
|
|
53
|
+
* belong to a nested menu.
|
|
54
|
+
*/
|
|
55
|
+
export function isAtCurrentMenuLevel(element, container) {
|
|
56
|
+
var closestMenu = element.closest(menuScope);
|
|
57
|
+
|
|
58
|
+
// Container itself has role="menu" — element belongs to this level
|
|
59
|
+
// if its closest menu is the container.
|
|
60
|
+
if (container.getAttribute('role') === 'menu') {
|
|
61
|
+
return closestMenu === container;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// Container is a wrapper without role="menu" (e.g. dropdown-menu
|
|
65
|
+
// wraps a MenuGroup). The element belongs to the top level if its
|
|
66
|
+
// closest role="menu" ancestor is a direct child of the container,
|
|
67
|
+
// i.e. there's no nested role="menu" between them.
|
|
68
|
+
if (closestMenu === null) {
|
|
69
|
+
return true;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Walk up from the closest menu to see if it's "owned" by this
|
|
73
|
+
// container without passing through another role="menu" first.
|
|
74
|
+
var parent = closestMenu.parentElement;
|
|
75
|
+
while (parent && parent !== container) {
|
|
76
|
+
if (parent.getAttribute('role') === 'menu') {
|
|
77
|
+
// There's a parent menu between the closest menu and the
|
|
78
|
+
// container — the element is in a nested sub-menu.
|
|
79
|
+
return false;
|
|
80
|
+
}
|
|
81
|
+
parent = parent.parentElement;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
// The closest menu is directly inside the container (no nesting).
|
|
85
|
+
return parent === container;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Provides arrow key navigation for menu containers.
|
|
89
|
+
*
|
|
90
|
+
* Uses the focusable helpers from `@atlaskit/top-layer/focus` to manage
|
|
91
|
+
* DOM-based focus movement within a container.
|
|
92
|
+
*
|
|
93
|
+
* - **ArrowDown / ArrowUp**: Move focus to the next/previous item (wraps).
|
|
94
|
+
* - **Home / End**: Move focus to the first/last item.
|
|
95
|
+
* - **Tab**: Calls `onClose` to exit the menu.
|
|
96
|
+
*
|
|
97
|
+
* When a `filter` is provided, it is used both for scoping focusable
|
|
98
|
+
* elements and as a guard to prevent parent menu handlers from acting
|
|
99
|
+
* on events that belong to a nested menu.
|
|
100
|
+
*
|
|
101
|
+
* @example Basic usage
|
|
102
|
+
* ```tsx
|
|
103
|
+
* useArrowNavigation({
|
|
104
|
+
* containerRef: menuRef,
|
|
105
|
+
* onClose: () => setIsOpen(false),
|
|
106
|
+
* isEnabled: isOpen,
|
|
107
|
+
* });
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @example With nested menu filter
|
|
111
|
+
* ```tsx
|
|
112
|
+
* import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
|
|
113
|
+
*
|
|
114
|
+
* useArrowNavigation({
|
|
115
|
+
* containerRef: menuRef,
|
|
116
|
+
* onClose: () => setIsOpen(false),
|
|
117
|
+
* isEnabled: isOpen,
|
|
118
|
+
* filter: isAtCurrentMenuLevel,
|
|
119
|
+
* });
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
export function useArrowNavigation(_ref) {
|
|
123
|
+
var containerRef = _ref.containerRef,
|
|
124
|
+
onClose = _ref.onClose,
|
|
125
|
+
onNestedOpen = _ref.onNestedOpen,
|
|
126
|
+
onNestedClose = _ref.onNestedClose,
|
|
127
|
+
_ref$isEnabled = _ref.isEnabled,
|
|
128
|
+
isEnabled = _ref$isEnabled === void 0 ? true : _ref$isEnabled,
|
|
129
|
+
filter = _ref.filter;
|
|
130
|
+
var handleKeyDown = useCallback(function (event) {
|
|
131
|
+
var _getDocument;
|
|
132
|
+
var container = containerRef.current;
|
|
133
|
+
if (!container) {
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// Guard: only handle the event if the currently focused element
|
|
138
|
+
// belongs to this menu level. The focused element's closest
|
|
139
|
+
// [role="menu"] must be this container (not a nested sub-menu).
|
|
140
|
+
// When no filter is provided, fall back to the closest-menu check
|
|
141
|
+
// if the container has role="menu".
|
|
142
|
+
var focused = (_getDocument = getDocument()) === null || _getDocument === void 0 ? void 0 : _getDocument.activeElement;
|
|
143
|
+
if (focused instanceof HTMLElement) {
|
|
144
|
+
if (filter) {
|
|
145
|
+
if (!filter(focused, container)) {
|
|
146
|
+
return;
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
if (!filter && container.getAttribute('role') === 'menu' && focused.closest(menuScope) !== container) {
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
if (event.key === KEY_DOWN) {
|
|
154
|
+
var _getNextFocusable;
|
|
155
|
+
// Prevent page scroll while navigating menu items.
|
|
156
|
+
event.preventDefault();
|
|
157
|
+
(_getNextFocusable = getNextFocusable({
|
|
158
|
+
container: container,
|
|
159
|
+
direction: 'forwards',
|
|
160
|
+
filter: filter
|
|
161
|
+
})) === null || _getNextFocusable === void 0 || _getNextFocusable.focus();
|
|
162
|
+
return;
|
|
163
|
+
}
|
|
164
|
+
if (event.key === KEY_UP) {
|
|
165
|
+
var _getNextFocusable2;
|
|
166
|
+
// Prevent page scroll while navigating menu items.
|
|
167
|
+
event.preventDefault();
|
|
168
|
+
(_getNextFocusable2 = getNextFocusable({
|
|
169
|
+
container: container,
|
|
170
|
+
direction: 'backwards',
|
|
171
|
+
filter: filter
|
|
172
|
+
})) === null || _getNextFocusable2 === void 0 || _getNextFocusable2.focus();
|
|
173
|
+
return;
|
|
174
|
+
}
|
|
175
|
+
if (event.key === KEY_HOME) {
|
|
176
|
+
var _getFirstFocusable;
|
|
177
|
+
// Prevent browser default (e.g. scrolling to top of page).
|
|
178
|
+
event.preventDefault();
|
|
179
|
+
(_getFirstFocusable = getFirstFocusable({
|
|
180
|
+
container: container,
|
|
181
|
+
filter: filter
|
|
182
|
+
})) === null || _getFirstFocusable === void 0 || _getFirstFocusable.focus();
|
|
183
|
+
return;
|
|
184
|
+
}
|
|
185
|
+
if (event.key === KEY_END) {
|
|
186
|
+
var _getLastFocusable;
|
|
187
|
+
// Prevent browser default (e.g. scrolling to bottom of page).
|
|
188
|
+
event.preventDefault();
|
|
189
|
+
(_getLastFocusable = getLastFocusable({
|
|
190
|
+
container: container,
|
|
191
|
+
filter: filter
|
|
192
|
+
})) === null || _getLastFocusable === void 0 || _getLastFocusable.focus();
|
|
193
|
+
return;
|
|
194
|
+
}
|
|
195
|
+
if (event.key === KEY_TAB) {
|
|
196
|
+
onClose();
|
|
197
|
+
return;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
// ── Nested menu navigation (WAI-ARIA menu pattern) ──
|
|
201
|
+
// ArrowRight on a menuitem with aria-haspopup opens the submenu.
|
|
202
|
+
if (event.key === 'ArrowRight') {
|
|
203
|
+
if (onNestedOpen && focused instanceof HTMLElement && focused.hasAttribute('aria-haspopup')) {
|
|
204
|
+
event.preventDefault();
|
|
205
|
+
onNestedOpen({
|
|
206
|
+
trigger: focused
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
return;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
// ArrowLeft closes the current menu if it is nested inside a parent menu.
|
|
213
|
+
if (event.key === 'ArrowLeft') {
|
|
214
|
+
if (onNestedClose) {
|
|
215
|
+
var _container$parentElem;
|
|
216
|
+
// Only close if this container is inside another role="menu"
|
|
217
|
+
// (i.e. it's a submenu, not the top-level menu).
|
|
218
|
+
// Walk up from the parent to avoid matching the container itself.
|
|
219
|
+
var isNested = ((_container$parentElem = container.parentElement) === null || _container$parentElem === void 0 ? void 0 : _container$parentElem.closest(menuScope)) !== null;
|
|
220
|
+
if (isNested) {
|
|
221
|
+
event.preventDefault();
|
|
222
|
+
onNestedClose();
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
return;
|
|
226
|
+
}
|
|
227
|
+
}, [containerRef, onClose, onNestedOpen, onNestedClose, filter]);
|
|
228
|
+
useEffect(function () {
|
|
229
|
+
var container = containerRef.current;
|
|
230
|
+
if (!container || !isEnabled) {
|
|
231
|
+
return;
|
|
232
|
+
}
|
|
233
|
+
return bind(container, {
|
|
234
|
+
type: 'keydown',
|
|
235
|
+
listener: handleKeyDown
|
|
236
|
+
});
|
|
237
|
+
}, [containerRef, handleKeyDown, isEnabled]);
|
|
238
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { useEffect, useRef } from 'react';
|
|
2
|
+
import { bind } from 'bind-event-listener';
|
|
3
|
+
/**
|
|
4
|
+
* Simple light-dismiss hook for `popover="manual"` elements.
|
|
5
|
+
*
|
|
6
|
+
* Provides Escape-to-close and click-outside-to-close behavior without
|
|
7
|
+
* relying on the browser's `popover="auto"` light-dismiss stack.
|
|
8
|
+
*
|
|
9
|
+
* **No stacking awareness:** This hook does not track a popover stack.
|
|
10
|
+
* If multiple manual popovers are open and all use this hook, a single
|
|
11
|
+
* Escape press or outside click will dismiss **all of them simultaneously**.
|
|
12
|
+
* This is by design — the hook is intentionally simple for cases where
|
|
13
|
+
* only one manual popover is open at a time.
|
|
14
|
+
*
|
|
15
|
+
* For stacked/nested popovers that should dismiss one-at-a-time, use
|
|
16
|
+
* `popover="auto"` mode instead, which provides native stack-aware
|
|
17
|
+
* light dismiss via the browser's top-layer stack.
|
|
18
|
+
*/
|
|
19
|
+
export function useSimpleLightDismiss(_ref) {
|
|
20
|
+
var popoverRef = _ref.popoverRef,
|
|
21
|
+
isOpen = _ref.isOpen,
|
|
22
|
+
onClose = _ref.onClose;
|
|
23
|
+
// Keep a stable ref to onClose so the effect doesn't re-bind on every render.
|
|
24
|
+
var onCloseRef = useRef(onClose);
|
|
25
|
+
onCloseRef.current = onClose;
|
|
26
|
+
useEffect(function () {
|
|
27
|
+
if (!isOpen) {
|
|
28
|
+
return;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- binding to document for light dismiss
|
|
32
|
+
var unbindEscape = bind(document, {
|
|
33
|
+
type: 'keydown',
|
|
34
|
+
listener: function listener(event) {
|
|
35
|
+
if (event.key === 'Escape') {
|
|
36
|
+
onCloseRef.current({
|
|
37
|
+
reason: 'escape'
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
// Listen for click-outside in the **capture** phase.
|
|
44
|
+
//
|
|
45
|
+
// The click that opened the popover propagates in bubble phase
|
|
46
|
+
// (trigger onClick → setIsOpen(true) → React render → useEffect).
|
|
47
|
+
// By the time this effect runs, the opening click has finished
|
|
48
|
+
// bubbling. A capture-phase listener added now cannot retroactively
|
|
49
|
+
// fire for that event — it only fires for *future* clicks.
|
|
50
|
+
//
|
|
51
|
+
// This avoids the need for timestamp guards or deferred binding.
|
|
52
|
+
// eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- binding to document for light dismiss
|
|
53
|
+
var unbindClickOutside = bind(document, {
|
|
54
|
+
type: 'click',
|
|
55
|
+
listener: function listener(event) {
|
|
56
|
+
var el = popoverRef.current;
|
|
57
|
+
if (!el) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// If the click target is inside the popover, don't dismiss.
|
|
62
|
+
if (event.target instanceof Node && el.contains(event.target)) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
onCloseRef.current({
|
|
66
|
+
reason: 'light-dismiss'
|
|
67
|
+
});
|
|
68
|
+
},
|
|
69
|
+
options: {
|
|
70
|
+
capture: true
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
return function () {
|
|
74
|
+
unbindEscape();
|
|
75
|
+
unbindClickOutside();
|
|
76
|
+
};
|
|
77
|
+
}, [isOpen, popoverRef]);
|
|
78
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { type TAnimationPreset } from './types';
|
|
2
|
+
type TSlideAndFadeOptions = {
|
|
3
|
+
/**
|
|
4
|
+
* Slide distance in pixels. Defaults to `4`.
|
|
5
|
+
*/
|
|
6
|
+
distance?: number;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* Directional slide + opacity animation.
|
|
10
|
+
*
|
|
11
|
+
* The popover slides in from the direction opposite its placement edge
|
|
12
|
+
* (e.g. a `block-end` popover slides down from above).
|
|
13
|
+
*
|
|
14
|
+
* @param options.distance - Slide distance in pixels. Defaults to `4`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```tsx
|
|
18
|
+
* import { slideAndFade } from '@atlaskit/top-layer/animations';
|
|
19
|
+
*
|
|
20
|
+
* // Default 4px slide (tooltip)
|
|
21
|
+
* <Popup.Content animate={slideAndFade()} />
|
|
22
|
+
*
|
|
23
|
+
* // Custom 8px slide (popup / dropdown)
|
|
24
|
+
* <Popup.Content animate={slideAndFade({ distance: 8 })} />
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export declare function slideAndFade(options?: TSlideAndFadeOptions): TAnimationPreset;
|
|
28
|
+
/**
|
|
29
|
+
* Simple opacity transition, no transform.
|
|
30
|
+
*
|
|
31
|
+
* Suitable for popup dialogs or content that does not need directional motion.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```tsx
|
|
35
|
+
* import { fade } from '@atlaskit/top-layer/animations';
|
|
36
|
+
*
|
|
37
|
+
* <Popup.Content animate={fade()} />
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
export declare function fade(): TAnimationPreset;
|
|
41
|
+
/**
|
|
42
|
+
* Scale from 0.95 + opacity transition.
|
|
43
|
+
*
|
|
44
|
+
* Suitable for menus, dropdowns, and select options.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```tsx
|
|
48
|
+
* import { scaleAndFade } from '@atlaskit/top-layer/animations';
|
|
49
|
+
*
|
|
50
|
+
* <Popup.Content animate={scaleAndFade()} />
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
export declare function scaleAndFade(): TAnimationPreset;
|
|
54
|
+
type TDialogSlideUpAndFadeOptions = {
|
|
55
|
+
/**
|
|
56
|
+
* Slide distance in pixels. Defaults to `12`.
|
|
57
|
+
*/
|
|
58
|
+
distance?: number;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Slide up + opacity animation for dialogs.
|
|
62
|
+
*
|
|
63
|
+
* Entry slides up from below; exit slides up and out (asymmetric).
|
|
64
|
+
* Includes backdrop fade animation.
|
|
65
|
+
*
|
|
66
|
+
* @param options.distance - Slide distance in pixels. Defaults to `12`.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```tsx
|
|
70
|
+
* import { dialogSlideUpAndFade } from '@atlaskit/top-layer/animations';
|
|
71
|
+
*
|
|
72
|
+
* const animation = dialogSlideUpAndFade();
|
|
73
|
+
* <Dialog animate={animation} isOpen={isOpen} onClose={handleClose} label="...">
|
|
74
|
+
* ...
|
|
75
|
+
* </Dialog>
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
export declare function dialogSlideUpAndFade(options?: TDialogSlideUpAndFadeOptions): TAnimationPreset;
|
|
79
|
+
/**
|
|
80
|
+
* Simple opacity transition for dialogs, no transform.
|
|
81
|
+
*
|
|
82
|
+
* Includes backdrop fade animation.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```tsx
|
|
86
|
+
* import { dialogFade } from '@atlaskit/top-layer/animations';
|
|
87
|
+
*
|
|
88
|
+
* <Dialog animate={dialogFade()} isOpen={isOpen} onClose={handleClose} label="...">
|
|
89
|
+
* ...
|
|
90
|
+
* </Dialog>
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
export declare function dialogFade(): TAnimationPreset;
|
|
94
|
+
export {};
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { type TPlacementOptions } from '../popup/types';
|
|
2
|
+
/**
|
|
3
|
+
* A self-contained animation preset for top-layer elements (popovers and dialogs).
|
|
4
|
+
*
|
|
5
|
+
* Contains the CSS rules (injected once into `<head>`), a data-attribute name
|
|
6
|
+
* for CSS targeting, optional per-placement custom properties, and the exit
|
|
7
|
+
* duration used for a `transitionend` fallback timeout.
|
|
8
|
+
*
|
|
9
|
+
* Entry animation uses `@starting-style`.
|
|
10
|
+
* Exit animation uses `allow-discrete` on `display`/`overlay` to keep the
|
|
11
|
+
* element visible in the top layer while CSS transitions play.
|
|
12
|
+
*/
|
|
13
|
+
export type TAnimationPreset = {
|
|
14
|
+
/**
|
|
15
|
+
* CSS to inject once into `document.head`, scoped via a data attribute
|
|
16
|
+
* (e.g. `[data-ds-popover-{name}]` or `[data-ds-dialog-{name}]`).
|
|
17
|
+
*/
|
|
18
|
+
css: string;
|
|
19
|
+
/**
|
|
20
|
+
* Data attribute suffix for CSS targeting (e.g. `'slide-and-fade'`).
|
|
21
|
+
*/
|
|
22
|
+
name: string;
|
|
23
|
+
/**
|
|
24
|
+
* Per-placement CSS custom properties (e.g. directional offset for
|
|
25
|
+
* `slideAndFade`). Only used by popover presets that vary by placement.
|
|
26
|
+
*/
|
|
27
|
+
getProperties?: (args: {
|
|
28
|
+
placement: TPlacementOptions;
|
|
29
|
+
}) => Record<string, string>;
|
|
30
|
+
/**
|
|
31
|
+
* Exit duration in ms (for `transitionend` fallback timeout).
|
|
32
|
+
*/
|
|
33
|
+
exitDurationMs: number;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* @deprecated Use `TAnimationPreset` instead.
|
|
37
|
+
*/
|
|
38
|
+
export type TPopoverAnimationPreset = TAnimationPreset;
|
|
39
|
+
/**
|
|
40
|
+
* @deprecated Use `TAnimationPreset` instead.
|
|
41
|
+
*/
|
|
42
|
+
export type TDialogAnimationPreset = TAnimationPreset;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { type TArrowPreset } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Creates an arrow preset for popover content.
|
|
4
|
+
*
|
|
5
|
+
* The returned object is passed to `PopoverContent`'s `arrow` prop.
|
|
6
|
+
* It carries the CSS string and fallback logic so that consumers who
|
|
7
|
+
* don't use arrows pay no bundle cost.
|
|
8
|
+
*
|
|
9
|
+
* The arrows inherit their background from the popover element.
|
|
10
|
+
* When `arrow` is active, `PopoverContent` does not reset `background`
|
|
11
|
+
* to `transparent`, allowing the UA default (`canvas`) or a consumer-set
|
|
12
|
+
* background to show through.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```tsx
|
|
16
|
+
* import { arrow } from '@atlaskit/top-layer/arrow';
|
|
17
|
+
*
|
|
18
|
+
* const myArrow = arrow();
|
|
19
|
+
*
|
|
20
|
+
* <Popup.Content arrow={myArrow} />
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
export declare const arrow: () => TArrowPreset;
|
|
24
|
+
export type { TArrowPreset } from './types';
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { type TPlacementOptions } from '../popup/types';
|
|
2
|
+
/**
|
|
3
|
+
* A self-contained arrow preset for PopoverContent.
|
|
4
|
+
*
|
|
5
|
+
* Contains the CSS rules (injected once into `<head>`), a data-attribute name
|
|
6
|
+
* for CSS targeting, and a function to compute `position-try-fallbacks` values
|
|
7
|
+
* that change both `position-area` and `margin` when the popover flips.
|
|
8
|
+
*
|
|
9
|
+
* Imported from `@atlaskit/top-layer/arrow` so that consumers who don't use
|
|
10
|
+
* arrows pay no bundle cost for the CSS string or fallback logic.
|
|
11
|
+
*/
|
|
12
|
+
export type TArrowPreset = {
|
|
13
|
+
/**
|
|
14
|
+
* CSS to inject once into `document.head`, scoped to `[data-ds-popover-{name}]`.
|
|
15
|
+
*/
|
|
16
|
+
css: string;
|
|
17
|
+
/**
|
|
18
|
+
* Data attribute suffix for CSS targeting (e.g. `'arrow'`).
|
|
19
|
+
*/
|
|
20
|
+
name: string;
|
|
21
|
+
/**
|
|
22
|
+
* Returns the `position-try-fallbacks` value for a given placement.
|
|
23
|
+
* Uses named `@position-try` rules that update both `position-area`
|
|
24
|
+
* and `margin` so the correct arrow is revealed after a flip.
|
|
25
|
+
*/
|
|
26
|
+
getTryFallbacks: (args: {
|
|
27
|
+
placement: TPlacementOptions;
|
|
28
|
+
}) => string;
|
|
29
|
+
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { type TDialogCloseReason } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Creates a synthetic DOM event from a `TDialogCloseReason`.
|
|
4
|
+
*
|
|
5
|
+
* Useful when bridging the Dialog primitive's `onClose({ reason })` callback
|
|
6
|
+
* to a legacy API that expects a `KeyboardEvent` or `MouseEvent` — for example,
|
|
7
|
+
* `@atlaskit/modal-dialog`'s `onClose(event, analyticsEvent)` contract.
|
|
8
|
+
*
|
|
9
|
+
* - `'escape'` → `KeyboardEvent('keydown', { key: 'Escape' })`
|
|
10
|
+
* - `'overlay-click'` → `MouseEvent('click')`
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```tsx
|
|
14
|
+
* import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
|
|
15
|
+
* import { type TDialogCloseReason } from '@atlaskit/top-layer/dialog';
|
|
16
|
+
*
|
|
17
|
+
* function onDialogClose({ reason }: { reason: TDialogCloseReason }) {
|
|
18
|
+
* legacyOnClose(createCloseEvent({ reason }));
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export declare function createCloseEvent({ reason, }: {
|
|
23
|
+
reason: TDialogCloseReason;
|
|
24
|
+
}): KeyboardEvent | MouseEvent;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import React from 'react';
|
|
6
|
+
import { type TDialogProps } from './types';
|
|
7
|
+
/**
|
|
8
|
+
* Low-level `<dialog>` primitive. No visual opinions — no width, height,
|
|
9
|
+
* background, border-radius, or layout. Consumers provide their own styling.
|
|
10
|
+
*
|
|
11
|
+
* Visibility is controlled declaratively via `isOpen`:
|
|
12
|
+
* - `isOpen={true}` calls `.showModal()` (entry animation via `@starting-style`)
|
|
13
|
+
* - `isOpen={false}` calls `.close()` (exit animation via `allow-discrete`)
|
|
14
|
+
*
|
|
15
|
+
* Handles native `cancel` event (Escape) and backdrop click detection.
|
|
16
|
+
*
|
|
17
|
+
* Close flow: we never call `dialog.close()` from event handlers. We always call
|
|
18
|
+
* `onClose`; the consumer decides whether to set `isOpen={false}`.
|
|
19
|
+
*/
|
|
20
|
+
export declare const Dialog: React.ForwardRefExoticComponent<TDialogProps & React.RefAttributes<HTMLDialogElement>>;
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { type CSSProperties, type ReactNode } from 'react';
|
|
2
|
+
import { type TAnimationPreset } from '../animations/types';
|
|
3
|
+
/**
|
|
4
|
+
* Close reasons produced by the Dialog primitive.
|
|
5
|
+
*
|
|
6
|
+
* - `'escape'` — user pressed Escape (native `cancel` event on `<dialog>`).
|
|
7
|
+
* - `'overlay-click'` — user clicked the backdrop / overlay area.
|
|
8
|
+
*
|
|
9
|
+
* Consumer-initiated ("programmatic") close is not a reason the primitive
|
|
10
|
+
* produces — the consumer simply sets `isOpen={false}`.
|
|
11
|
+
*/
|
|
12
|
+
export type TDialogCloseReason = 'escape' | 'overlay-click';
|
|
13
|
+
/**
|
|
14
|
+
* Props for the `Dialog` primitive.
|
|
15
|
+
*
|
|
16
|
+
* Low-level wrapper around the native `<dialog>` element.
|
|
17
|
+
* Manages visibility (`showModal()` / `close()`), animation, Escape handling,
|
|
18
|
+
* and backdrop-click detection. Has no visual opinions — no width, height,
|
|
19
|
+
* background, border-radius, or layout. Consumers (e.g. `@atlaskit/modal-dialog`)
|
|
20
|
+
* provide their own visual styling.
|
|
21
|
+
*/
|
|
22
|
+
export type TDialogProps = {
|
|
23
|
+
children: ReactNode;
|
|
24
|
+
/**
|
|
25
|
+
* Whether the dialog is open.
|
|
26
|
+
*
|
|
27
|
+
* - `true`: calls `showModal()`, entry animation plays via `@starting-style`.
|
|
28
|
+
* - `false`: calls `close()`. When an `animate` preset is provided, the exit
|
|
29
|
+
* animation plays (via `allow-discrete`) before the dialog becomes logically closed.
|
|
30
|
+
*
|
|
31
|
+
* The element stays mounted in the DOM — visibility is controlled declaratively.
|
|
32
|
+
*/
|
|
33
|
+
isOpen: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Called when the user triggers close via Escape or backdrop click.
|
|
36
|
+
*
|
|
37
|
+
* The dialog does **not** close itself — the consumer decides whether to
|
|
38
|
+
* set `isOpen={false}` (e.g. gate by reason).
|
|
39
|
+
*/
|
|
40
|
+
onClose: (args: {
|
|
41
|
+
reason: TDialogCloseReason;
|
|
42
|
+
}) => void;
|
|
43
|
+
/**
|
|
44
|
+
* Animation preset for entry/exit transitions.
|
|
45
|
+
*
|
|
46
|
+
* Pass an `TAnimationPreset` (e.g. `dialogSlideUpAndFade()`) to enable
|
|
47
|
+
* CSS-based entry and exit animation. Pass `false` (or omit) to disable.
|
|
48
|
+
*/
|
|
49
|
+
animate?: TAnimationPreset | false;
|
|
50
|
+
/**
|
|
51
|
+
* Additional inline styles applied to the `<dialog>` element.
|
|
52
|
+
*
|
|
53
|
+
* Use for custom width, height, transform, or other overrides.
|
|
54
|
+
*/
|
|
55
|
+
style?: CSSProperties;
|
|
56
|
+
/**
|
|
57
|
+
* Test ID applied to the `<dialog>` element.
|
|
58
|
+
*/
|
|
59
|
+
testId?: string;
|
|
60
|
+
/**
|
|
61
|
+
* HTML `id` attribute for the `<dialog>` element.
|
|
62
|
+
*/
|
|
63
|
+
id?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Accessible label (`aria-label`).
|
|
66
|
+
*
|
|
67
|
+
* When provided, `aria-labelledby` is not set.
|
|
68
|
+
* Use when there is no visible title element to reference.
|
|
69
|
+
*/
|
|
70
|
+
label?: string;
|
|
71
|
+
/**
|
|
72
|
+
* ID of the element that labels the dialog (`aria-labelledby`).
|
|
73
|
+
*
|
|
74
|
+
* Ignored when `label` is provided.
|
|
75
|
+
*/
|
|
76
|
+
labelledBy?: string;
|
|
77
|
+
/**
|
|
78
|
+
* When true, the `::backdrop` pseudo-element is rendered transparent.
|
|
79
|
+
*
|
|
80
|
+
* Useful for stacked dialogs where only the foreground dialog should
|
|
81
|
+
* show a visible backdrop, or when the consumer wants no overlay.
|
|
82
|
+
*/
|
|
83
|
+
shouldHideBackdrop?: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* Called after the exit animation completes (or immediately on close when
|
|
86
|
+
* there is no animation or reduced motion is active).
|
|
87
|
+
*
|
|
88
|
+
* Use this for external lifecycle coordination — e.g. firing an
|
|
89
|
+
* `onCloseComplete` callback or notifying ExitingPersistence.
|
|
90
|
+
*/
|
|
91
|
+
onExitFinish?: () => void;
|
|
92
|
+
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* __DialogScrollLock__
|
|
3
|
+
*
|
|
4
|
+
* Prevents background page scrolling while mounted. Designed to be rendered
|
|
5
|
+
* inside a `Dialog` so that the scroll lock is automatically removed when the
|
|
6
|
+
* dialog closes (unmounts its children).
|
|
7
|
+
*
|
|
8
|
+
* Native `<dialog>.showModal()` makes background content _inert_ (not
|
|
9
|
+
* focusable/clickable), but does **not** prevent scroll events from reaching
|
|
10
|
+
* the document body. This component fills that gap by setting
|
|
11
|
+
* `overflow: hidden` on `document.body`.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```tsx
|
|
15
|
+
* import { Dialog } from '@atlaskit/top-layer/dialog';
|
|
16
|
+
* import { DialogScrollLock } from '@atlaskit/top-layer/dialog-scroll-lock';
|
|
17
|
+
*
|
|
18
|
+
* <Dialog isOpen={isOpen} onClose={onClose}>
|
|
19
|
+
* <DialogScrollLock />
|
|
20
|
+
* {children}
|
|
21
|
+
* </Dialog>
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
export declare function DialogScrollLock(): null;
|