@atlaskit/top-layer 0.17.0 → 1.0.0

package/dist/types-ts4.5/use-arrow-navigation/use-arrow-navigation.d.ts

@@ -1,102 +0,0 @@
-import { type RefObject } from 'react';
-import { type TFocusableFilter } from '../focus/types';
-/**
- * Args for `useArrowNavigation`.
- *
- * Keyboard contract:
- * - `ArrowDown` / `ArrowUp` move within the current menu level.
- * - `Home` / `End` jump to first / last.
- * - `ArrowRight` / `ArrowLeft` opens / closes nested submenus.
- * - `Tab` / `Shift+Tab` dismiss the menu (matching the ARIA APG menu pattern,
- *   plus Radix UI / Headless UI / React Aria / Floating UI conventions).
- *   Symmetric in both directions: there is no special-case for the last
- *   item that lets Tab leave the menu without dismissing it.
- * - `Page Up` / `Page Down`: NOT handled - extend via your own listener if
- *   your menu needs page-style scrolling.
- */
-export type TUseArrowNavigationArgs = {
-    /**
-     * Ref to the container element that holds the focusable items.
-     */
-    containerRef: RefObject<HTMLElement | null>;
-    /**
-     * Called when ArrowRight is pressed on a focused element with `aria-haspopup`.
-     *
-     * This follows the WAI-ARIA menu pattern: ArrowRight on a menu item that
-     * controls a submenu should open that submenu. The consumer decides *how*
-     * to open it (e.g. `trigger.click()`, imperative state update, etc.).
-     *
-     * Only fires when `filter` (if provided) confirms the focused element
-     * belongs to the current menu level.
-     */
-    onNestedOpen?: ({ trigger }: {
-        trigger: HTMLElement;
-    }) => void;
-    /**
-     * Called when ArrowLeft is pressed and the current menu is nested
-     * (i.e. the container is inside another `role="menu"`).
-     *
-     * This follows the WAI-ARIA menu pattern: ArrowLeft in a submenu
-     * should close it and return to the parent menu. The consumer
-     * decides *how* to close (e.g. calling their close handler).
-     */
-    onNestedClose?: () => void;
-    /**
-     * Called when the user presses Tab to exit the menu.
-     */
-    onClose: () => void;
-    /**
-     * When false, the keydown listener is not attached.
-     * Defaults to true.
-     */
-    isEnabled?: boolean;
-    /**
-     * Optional filter to restrict which focusable elements are navigated.
-     * When provided, only elements that pass the filter will be focused.
-     *
-     * The filter is also used as a guard on the currently focused element:
-     * if the focused element does not pass the filter, the handler bails out.
-     * This prevents parent menu handlers from acting on events that belong
-     * to a nested menu.
-     *
-     * A common filter is `isAtCurrentMenuLevel` which excludes items inside
-     * nested `role="menu"` sub-containers.
-     */
-    filter?: TFocusableFilter;
-};
-/**
- * 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,
- * });
- * ```
- */
-export declare function useArrowNavigation({ containerRef, onClose, onNestedOpen, onNestedClose, isEnabled, filter, }: TUseArrowNavigationArgs): void;

package/dist/types-ts4.5/use-simple-light-dismiss/index.d.ts

@@ -1,45 +0,0 @@
-import { type RefObject } from 'react';
-import { type TPopoverCloseReason } from '../popover/types';
-type TUseSimpleLightDismissOptions = {
-    /**
-     * Ref to the popover element. Clicks inside this element will not trigger dismiss.
-     */
-    popoverRef: RefObject<HTMLElement | null>;
-    /**
-     * Whether the popover is currently open.
-     * Listeners are only bound when `isOpen` is `true`.
-     */
-    isOpen: boolean;
-    /**
-     * Called when a light-dismiss event occurs.
-     *
-     * - `reason: 'escape'` - the user pressed the Escape key.
-     * - `reason: 'light-dismiss'` - the user clicked outside the popover.
-     *
-     * **Note:** This hook provides simple, standalone light dismiss that does not
-     * participate in the browser's `popover="auto"` dismiss stack. Every active
-     * instance will fire independently - if multiple popovers use this hook,
-     * they will all receive dismiss events.
-     */
-    onClose: (args: {
-        reason: TPopoverCloseReason;
-    }) => void;
-};
-/**
- * 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.
- */
-export declare function useSimpleLightDismiss({ popoverRef, isOpen, onClose, }: TUseSimpleLightDismissOptions): void;
-export type { TUseSimpleLightDismissOptions };