@atlaskit/top-layer 0.1.0

package/dist/cjs/use-arrow-navigation/use-arrow-navigation.js

@@ -0,0 +1,245 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isAtCurrentMenuLevel = isAtCurrentMenuLevel;
+exports.useArrowNavigation = useArrowNavigation;
+var _react = require("react");
+var _bindEventListener = require("bind-event-listener");
+var _browserApis = require("@atlaskit/browser-apis");
+var _keycodes = require("@atlaskit/ds-lib/keycodes");
+var _focus = require("../focus");
+var menuScope = '[role="menu"]';
+
+/**
+ * Returns true if the element belongs to the current menu level of the
+ * container — i.e. it is NOT inside a nested `role="menu"` sub-container.
+ *
+ * Uses `element.closest('[role="menu"]')` to determine the nearest menu
+ * scope. If the nearest scope is the container's own `role="menu"` element,
+ * the element belongs to this level. If it's a different (nested) menu,
+ * the element belongs to a child level and should be excluded.
+ *
+ * Supports two container patterns:
+ *
+ * **1. Container has `role="menu"` directly** (preferred — used by avatar-group):
+ *   ```
+ *   <div ref={containerRef} role="menu">
+ *     <button role="menuitem" />   ← isAtCurrentMenuLevel → true
+ *     <div role="menu">            ← nested sub-menu
+ *       <button role="menuitem" /> ← isAtCurrentMenuLevel → false
+ *     </div>
+ *   </div>
+ *   ```
+ *   Uses the simple check: `element.closest('[role="menu"]') === container`
+ *
+ * **2. Container is a wrapper without `role="menu"`** (used by dropdown-menu,
+ *   where `MenuGroup` owns `role="menu"` but doesn't accept a ref):
+ *   ```
+ *   <div ref={containerRef}>         ← wrapper (no role="menu")
+ *     <MenuGroup role="menu">
+ *       <button role="menuitem" />   ← isAtCurrentMenuLevel → true
+ *       <div role="menu">            ← nested sub-menu
+ *         <button role="menuitem" /> ← isAtCurrentMenuLevel → false
+ *       </div>
+ *     </MenuGroup>
+ *   </div>
+ *   ```
+ *   Falls back to walking the DOM to check that the element's closest
+ *   `role="menu"` is the container's own menu (not doubly nested).
+ *
+ * Ideally all consumers should use pattern 1 (place the ref directly on the
+ * `role="menu"` element). Pattern 2 exists because `@atlaskit/menu`'s
+ * `MenuGroup` does not currently accept a ref. If `MenuGroup` gains ref
+ * support in the future, dropdown-menu should switch to pattern 1 and the
+ * fallback path can be removed.
+ *
+ * Used both as a `TFocusableFilter` (to scope getNextFocusable etc.) and as
+ * a guard to prevent parent menu handlers from acting on events that
+ * belong to a nested menu.
+ */
+function isAtCurrentMenuLevel(element, container) {
+  var closestMenu = element.closest(menuScope);
+
+  // Container itself has role="menu" — element belongs to this level
+  // if its closest menu is the container.
+  if (container.getAttribute('role') === 'menu') {
+    return closestMenu === container;
+  }
+
+  // Container is a wrapper without role="menu" (e.g. dropdown-menu
+  // wraps a MenuGroup). The element belongs to the top level if its
+  // closest role="menu" ancestor is a direct child of the container,
+  // i.e. there's no nested role="menu" between them.
+  if (closestMenu === null) {
+    return true;
+  }
+
+  // Walk up from the closest menu to see if it's "owned" by this
+  // container without passing through another role="menu" first.
+  var parent = closestMenu.parentElement;
+  while (parent && parent !== container) {
+    if (parent.getAttribute('role') === 'menu') {
+      // There's a parent menu between the closest menu and the
+      // container — the element is in a nested sub-menu.
+      return false;
+    }
+    parent = parent.parentElement;
+  }
+
+  // The closest menu is directly inside the container (no nesting).
+  return parent === container;
+}
+/**
+ * Provides arrow key navigation for menu containers.
+ *
+ * Uses the focusable helpers from `@atlaskit/top-layer/focus` to manage
+ * DOM-based focus movement within a container.
+ *
+ * - **ArrowDown / ArrowUp**: Move focus to the next/previous item (wraps).
+ * - **Home / End**: Move focus to the first/last item.
+ * - **Tab**: Calls `onClose` to exit the menu.
+ *
+ * When a `filter` is provided, it is used both for scoping focusable
+ * elements and as a guard to prevent parent menu handlers from acting
+ * on events that belong to a nested menu.
+ *
+ * @example Basic usage
+ * ```tsx
+ * useArrowNavigation({
+ *   containerRef: menuRef,
+ *   onClose: () => setIsOpen(false),
+ *   isEnabled: isOpen,
+ * });
+ * ```
+ *
+ * @example With nested menu filter
+ * ```tsx
+ * import { useArrowNavigation, isAtCurrentMenuLevel } from '@atlaskit/top-layer/use-arrow-navigation';
+ *
+ * useArrowNavigation({
+ *   containerRef: menuRef,
+ *   onClose: () => setIsOpen(false),
+ *   isEnabled: isOpen,
+ *   filter: isAtCurrentMenuLevel,
+ * });
+ * ```
+ */
+function useArrowNavigation(_ref) {
+  var containerRef = _ref.containerRef,
+    onClose = _ref.onClose,
+    onNestedOpen = _ref.onNestedOpen,
+    onNestedClose = _ref.onNestedClose,
+    _ref$isEnabled = _ref.isEnabled,
+    isEnabled = _ref$isEnabled === void 0 ? true : _ref$isEnabled,
+    filter = _ref.filter;
+  var handleKeyDown = (0, _react.useCallback)(function (event) {
+    var _getDocument;
+    var container = containerRef.current;
+    if (!container) {
+      return;
+    }
+
+    // Guard: only handle the event if the currently focused element
+    // belongs to this menu level. The focused element's closest
+    // [role="menu"] must be this container (not a nested sub-menu).
+    // When no filter is provided, fall back to the closest-menu check
+    // if the container has role="menu".
+    var focused = (_getDocument = (0, _browserApis.getDocument)()) === null || _getDocument === void 0 ? void 0 : _getDocument.activeElement;
+    if (focused instanceof HTMLElement) {
+      if (filter) {
+        if (!filter(focused, container)) {
+          return;
+        }
+      }
+      if (!filter && container.getAttribute('role') === 'menu' && focused.closest(menuScope) !== container) {
+        return;
+      }
+    }
+    if (event.key === _keycodes.KEY_DOWN) {
+      var _getNextFocusable;
+      // Prevent page scroll while navigating menu items.
+      event.preventDefault();
+      (_getNextFocusable = (0, _focus.getNextFocusable)({
+        container: container,
+        direction: 'forwards',
+        filter: filter
+      })) === null || _getNextFocusable === void 0 || _getNextFocusable.focus();
+      return;
+    }
+    if (event.key === _keycodes.KEY_UP) {
+      var _getNextFocusable2;
+      // Prevent page scroll while navigating menu items.
+      event.preventDefault();
+      (_getNextFocusable2 = (0, _focus.getNextFocusable)({
+        container: container,
+        direction: 'backwards',
+        filter: filter
+      })) === null || _getNextFocusable2 === void 0 || _getNextFocusable2.focus();
+      return;
+    }
+    if (event.key === _keycodes.KEY_HOME) {
+      var _getFirstFocusable;
+      // Prevent browser default (e.g. scrolling to top of page).
+      event.preventDefault();
+      (_getFirstFocusable = (0, _focus.getFirstFocusable)({
+        container: container,
+        filter: filter
+      })) === null || _getFirstFocusable === void 0 || _getFirstFocusable.focus();
+      return;
+    }
+    if (event.key === _keycodes.KEY_END) {
+      var _getLastFocusable;
+      // Prevent browser default (e.g. scrolling to bottom of page).
+      event.preventDefault();
+      (_getLastFocusable = (0, _focus.getLastFocusable)({
+        container: container,
+        filter: filter
+      })) === null || _getLastFocusable === void 0 || _getLastFocusable.focus();
+      return;
+    }
+    if (event.key === _keycodes.KEY_TAB) {
+      onClose();
+      return;
+    }
+
+    // ── Nested menu navigation (WAI-ARIA menu pattern) ──
+    // ArrowRight on a menuitem with aria-haspopup opens the submenu.
+    if (event.key === 'ArrowRight') {
+      if (onNestedOpen && focused instanceof HTMLElement && focused.hasAttribute('aria-haspopup')) {
+        event.preventDefault();
+        onNestedOpen({
+          trigger: focused
+        });
+      }
+      return;
+    }
+
+    // ArrowLeft closes the current menu if it is nested inside a parent menu.
+    if (event.key === 'ArrowLeft') {
+      if (onNestedClose) {
+        var _container$parentElem;
+        // Only close if this container is inside another role="menu"
+        // (i.e. it's a submenu, not the top-level menu).
+        // Walk up from the parent to avoid matching the container itself.
+        var isNested = ((_container$parentElem = container.parentElement) === null || _container$parentElem === void 0 ? void 0 : _container$parentElem.closest(menuScope)) !== null;
+        if (isNested) {
+          event.preventDefault();
+          onNestedClose();
+        }
+      }
+      return;
+    }
+  }, [containerRef, onClose, onNestedOpen, onNestedClose, filter]);
+  (0, _react.useEffect)(function () {
+    var container = containerRef.current;
+    if (!container || !isEnabled) {
+      return;
+    }
+    return (0, _bindEventListener.bind)(container, {
+      type: 'keydown',
+      listener: handleKeyDown
+    });
+  }, [containerRef, handleKeyDown, isEnabled]);
+}

package/dist/cjs/use-simple-light-dismiss/index.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useSimpleLightDismiss = useSimpleLightDismiss;
+var _react = require("react");
+var _bindEventListener = require("bind-event-listener");
+/**
+ * Simple light-dismiss hook for `popover="manual"` elements.
+ *
+ * Provides Escape-to-close and click-outside-to-close behavior without
+ * relying on the browser's `popover="auto"` light-dismiss stack.
+ *
+ * **No stacking awareness:** This hook does not track a popover stack.
+ * If multiple manual popovers are open and all use this hook, a single
+ * Escape press or outside click will dismiss **all of them simultaneously**.
+ * This is by design — the hook is intentionally simple for cases where
+ * only one manual popover is open at a time.
+ *
+ * For stacked/nested popovers that should dismiss one-at-a-time, use
+ * `popover="auto"` mode instead, which provides native stack-aware
+ * light dismiss via the browser's top-layer stack.
+ */
+function useSimpleLightDismiss(_ref) {
+  var popoverRef = _ref.popoverRef,
+    isOpen = _ref.isOpen,
+    onClose = _ref.onClose;
+  // Keep a stable ref to onClose so the effect doesn't re-bind on every render.
+  var onCloseRef = (0, _react.useRef)(onClose);
+  onCloseRef.current = onClose;
+  (0, _react.useEffect)(function () {
+    if (!isOpen) {
+      return;
+    }
+
+    // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- binding to document for light dismiss
+    var unbindEscape = (0, _bindEventListener.bind)(document, {
+      type: 'keydown',
+      listener: function listener(event) {
+        if (event.key === 'Escape') {
+          onCloseRef.current({
+            reason: 'escape'
+          });
+        }
+      }
+    });
+
+    // Listen for click-outside in the **capture** phase.
+    //
+    // The click that opened the popover propagates in bubble phase
+    // (trigger onClick → setIsOpen(true) → React render → useEffect).
+    // By the time this effect runs, the opening click has finished
+    // bubbling. A capture-phase listener added now cannot retroactively
+    // fire for that event — it only fires for *future* clicks.
+    //
+    // This avoids the need for timestamp guards or deferred binding.
+    // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- binding to document for light dismiss
+    var unbindClickOutside = (0, _bindEventListener.bind)(document, {
+      type: 'click',
+      listener: function listener(event) {
+        var el = popoverRef.current;
+        if (!el) {
+          return;
+        }
+
+        // If the click target is inside the popover, don't dismiss.
+        if (event.target instanceof Node && el.contains(event.target)) {
+          return;
+        }
+        onCloseRef.current({
+          reason: 'light-dismiss'
+        });
+      },
+      options: {
+        capture: true
+      }
+    });
+    return function () {
+      unbindEscape();
+      unbindClickOutside();
+    };
+  }, [isOpen, popoverRef]);
+}

package/dist/es2019/animations/presets.js

@@ -0,0 +1,375 @@
+import { getPlacement } from '../internal/use-anchor-positioning';
+
+// ── slideAndFade ──
+
+function getSlideAndFadeProperties({
+  placement,
+  distance
+}) {
+  const pos = `${distance}px`;
+  const neg = `-${distance}px`;
+  const {
+    axis,
+    edge
+  } = getPlacement({
+    placement
+  });
+  if (axis === 'block' && edge === 'start') {
+    return {
+      '--ds-popover-tx': '0',
+      '--ds-popover-ty': pos
+    };
+  }
+  if (axis === 'block' && edge === 'end') {
+    return {
+      '--ds-popover-tx': '0',
+      '--ds-popover-ty': neg
+    };
+  }
+  if (axis === 'inline' && edge === 'start') {
+    return {
+      '--ds-popover-tx': pos,
+      '--ds-popover-ty': '0'
+    };
+  }
+  if (axis === 'inline' && edge === 'end') {
+    return {
+      '--ds-popover-tx': neg,
+      '--ds-popover-ty': '0'
+    };
+  }
+  return {
+    '--ds-popover-tx': '0',
+    '--ds-popover-ty': neg
+  };
+}
+const SLIDE_AND_FADE_CSS = `
+[data-ds-popover-slide-and-fade] {
+  opacity: 0;
+  transform: translate3d(var(--ds-popover-tx, 0), var(--ds-popover-ty, 0), 0);
+  transition:
+    opacity 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    transform 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-popover-slide-and-fade]:popover-open {
+  opacity: 1;
+  transform: none;
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-popover-slide-and-fade]:popover-open {
+    opacity: 0;
+    transform: translate3d(var(--ds-popover-tx, 0), var(--ds-popover-ty, 0), 0);
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  [data-ds-popover-slide-and-fade],
+  [data-ds-popover-slide-and-fade]:popover-open {
+    transition-duration: 0s;
+  }
+}
+`;
+
+/**
+ * Directional slide + opacity animation.
+ *
+ * The popover slides in from the direction opposite its placement edge
+ * (e.g. a `block-end` popover slides down from above).
+ *
+ * @param options.distance - Slide distance in pixels. Defaults to `4`.
+ *
+ * @example
+ * ```tsx
+ * import { slideAndFade } from '@atlaskit/top-layer/animations';
+ *
+ * // Default 4px slide (tooltip)
+ * <Popup.Content animate={slideAndFade()} />
+ *
+ * // Custom 8px slide (popup / dropdown)
+ * <Popup.Content animate={slideAndFade({ distance: 8 })} />
+ * ```
+ */
+export function slideAndFade(options) {
+  var _options$distance;
+  const distance = (_options$distance = options === null || options === void 0 ? void 0 : options.distance) !== null && _options$distance !== void 0 ? _options$distance : 4;
+  return {
+    name: 'slide-and-fade',
+    css: SLIDE_AND_FADE_CSS,
+    getProperties: ({
+      placement
+    }) => getSlideAndFadeProperties({
+      placement,
+      distance
+    }),
+    exitDurationMs: 175
+  };
+}
+
+// ── fade ──
+
+const FADE_CSS = `
+[data-ds-popover-fade] {
+  opacity: 0;
+  transition:
+    opacity 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-popover-fade]:popover-open {
+  opacity: 1;
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-popover-fade]:popover-open {
+    opacity: 0;
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  [data-ds-popover-fade],
+  [data-ds-popover-fade]:popover-open {
+    transition-duration: 0s;
+  }
+}
+`;
+
+/**
+ * Simple opacity transition, no transform.
+ *
+ * Suitable for popup dialogs or content that does not need directional motion.
+ *
+ * @example
+ * ```tsx
+ * import { fade } from '@atlaskit/top-layer/animations';
+ *
+ * <Popup.Content animate={fade()} />
+ * ```
+ */
+export function fade() {
+  return {
+    name: 'fade',
+    css: FADE_CSS,
+    exitDurationMs: 175
+  };
+}
+
+// ── scaleAndFade ──
+
+const SCALE_AND_FADE_CSS = `
+[data-ds-popover-scale-and-fade] {
+  opacity: 0;
+  transform: scale(0.95);
+  transition:
+    opacity 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    transform 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-popover-scale-and-fade]:popover-open {
+  opacity: 1;
+  transform: none;
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-popover-scale-and-fade]:popover-open {
+    opacity: 0;
+    transform: scale(0.95);
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  [data-ds-popover-scale-and-fade],
+  [data-ds-popover-scale-and-fade]:popover-open {
+    transition-duration: 0s;
+  }
+}
+`;
+
+/**
+ * Scale from 0.95 + opacity transition.
+ *
+ * Suitable for menus, dropdowns, and select options.
+ *
+ * @example
+ * ```tsx
+ * import { scaleAndFade } from '@atlaskit/top-layer/animations';
+ *
+ * <Popup.Content animate={scaleAndFade()} />
+ * ```
+ */
+export function scaleAndFade() {
+  return {
+    name: 'scale-and-fade',
+    css: SCALE_AND_FADE_CSS,
+    exitDurationMs: 175
+  };
+}
+
+// ══════════════════════════════════════════════════════════════════════════════
+// Dialog presets
+// ══════════════════════════════════════════════════════════════════════════════
+
+// ── dialogSlideUpAndFade ──
+
+const DIALOG_SLIDE_UP_AND_FADE_CSS = `
+[data-ds-dialog-slide-up-and-fade] {
+  opacity: 0;
+  transform: translateY(calc(-1 * var(--ds-dialog-ty, 12px)));
+  transition:
+    opacity 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    transform 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-dialog-slide-up-and-fade][open] {
+  opacity: 1;
+  transform: none;
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-dialog-slide-up-and-fade][open] {
+    opacity: 0;
+    transform: translateY(var(--ds-dialog-ty, 12px));
+  }
+}
+
+[data-ds-dialog-slide-up-and-fade]::backdrop {
+  background-color: transparent;
+  transition:
+    background-color 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-dialog-slide-up-and-fade][open]::backdrop {
+  background-color: var(--ds-blanket, #050C1F75);
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-dialog-slide-up-and-fade][open]::backdrop {
+    background-color: transparent;
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  [data-ds-dialog-slide-up-and-fade],
+  [data-ds-dialog-slide-up-and-fade][open],
+  [data-ds-dialog-slide-up-and-fade]::backdrop,
+  [data-ds-dialog-slide-up-and-fade][open]::backdrop {
+    transition-duration: 0s;
+  }
+}
+`;
+
+/**
+ * Slide up + opacity animation for dialogs.
+ *
+ * Entry slides up from below; exit slides up and out (asymmetric).
+ * Includes backdrop fade animation.
+ *
+ * @param options.distance - Slide distance in pixels. Defaults to `12`.
+ *
+ * @example
+ * ```tsx
+ * import { dialogSlideUpAndFade } from '@atlaskit/top-layer/animations';
+ *
+ * const animation = dialogSlideUpAndFade();
+ * <Dialog animate={animation} isOpen={isOpen} onClose={handleClose} label="...">
+ *   ...
+ * </Dialog>
+ * ```
+ */
+export function dialogSlideUpAndFade(options) {
+  var _options$distance2;
+  const distance = (_options$distance2 = options === null || options === void 0 ? void 0 : options.distance) !== null && _options$distance2 !== void 0 ? _options$distance2 : 12;
+  return {
+    name: distance === 12 ? 'dialog-slide-up-and-fade' : `dialog-slide-up-and-fade-${distance}`,
+    css: distance === 12 ? DIALOG_SLIDE_UP_AND_FADE_CSS : DIALOG_SLIDE_UP_AND_FADE_CSS.replace(/12px/g, `${distance}px`),
+    exitDurationMs: 175
+  };
+}
+
+// ── dialogFade ──
+
+const DIALOG_FADE_CSS = `
+[data-ds-dialog-fade] {
+  opacity: 0;
+  transition:
+    opacity 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-dialog-fade][open] {
+  opacity: 1;
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-dialog-fade][open] {
+    opacity: 0;
+  }
+}
+
+[data-ds-dialog-fade]::backdrop {
+  background-color: transparent;
+  transition:
+    background-color 175ms cubic-bezier(0.15, 1, 0.3, 1),
+    overlay 175ms allow-discrete,
+    display 175ms allow-discrete;
+}
+
+[data-ds-dialog-fade][open]::backdrop {
+  background-color: var(--ds-blanket, #050C1F75);
+  transition-duration: 350ms;
+}
+
+@starting-style {
+  [data-ds-dialog-fade][open]::backdrop {
+    background-color: transparent;
+  }
+}
+
+@media (prefers-reduced-motion: reduce) {
+  [data-ds-dialog-fade],
+  [data-ds-dialog-fade][open],
+  [data-ds-dialog-fade]::backdrop,
+  [data-ds-dialog-fade][open]::backdrop {
+    transition-duration: 0s;
+  }
+}
+`;
+
+/**
+ * Simple opacity transition for dialogs, no transform.
+ *
+ * Includes backdrop fade animation.
+ *
+ * @example
+ * ```tsx
+ * import { dialogFade } from '@atlaskit/top-layer/animations';
+ *
+ * <Dialog animate={dialogFade()} isOpen={isOpen} onClose={handleClose} label="...">
+ *   ...
+ * </Dialog>
+ * ```
+ */
+export function dialogFade() {
+  return {
+    name: 'dialog-fade',
+    css: DIALOG_FADE_CSS,
+    exitDurationMs: 175
+  };
+}

package/dist/es2019/animations/types.js

@@ -0,0 +1 @@
+export {};