@react-md/core 1.0.0-next.9 → 6.0.1

package/dist/movement/useKeyboardMovementProvider.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="react" />
 import type { KeyboardMovementContext, KeyboardMovementProviderImplementation, KeyboardMovementProviderOptions } from "./types.js";
 export declare const KeyboardMovementProvider: import("react").Provider<KeyboardMovementContext>;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementContext>;
@@ -10,13 +9,12 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  * Implements the custom keyboard movement behavior throughout react-md. Using
  * the "Find References" will be the best way to see example usage.
  *
- * @example
- * Default Keyboard Movement for any Focusable Element
+ * @example Default Keyboard Movement for any Focusable Element
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  *
  * function Example({ children }: { children: ReactNode }): ReactElement {
@@ -34,14 +32,13 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  * }
  * ```
  *
- * @example
- * Active Descendant Movement
+ * @example Active Descendant Movement
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementContext,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  * import { useId } from "react";
  *
@@ -81,14 +78,13 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  * }
  * ```
  *
- * @example
- * Roving Tab Index
+ * @example Roving Tab Index
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementContext,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  * import { useId } from "react";
  *
@@ -127,7 +123,7 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  *   );
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function useKeyboardMovementProvider<E extends HTMLElement>(options?: KeyboardMovementProviderOptions<E>): KeyboardMovementProviderImplementation<E>;

package/dist/movement/useKeyboardMovementProvider.js

@@ -8,7 +8,7 @@ import { DEFAULT_KEYBOARD_MOVEMENT, DEFAULT_LTR_KEYBOARD_MOVEMENT, DEFAULT_RTL_K
 import { findMatchIndex } from "./findMatchIndex.js";
 import { getFirstFocusableIndex, getLastFocusableIndex, getNextFocusableIndex, getSearchText, getVirtualFocusDefaultIndex, isElementDisabled, isNotFocusable, isSearchableEvent, recalculateFocusIndex } from "./utils.js";
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ const context = createContext({
     config: {
@@ -24,7 +24,7 @@ import { getFirstFocusableIndex, getLastFocusableIndex, getNextFocusableIndex, g
 context.displayName = "KeyboardMovement";
 export const { Provider: KeyboardMovementProvider } = context;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export function useKeyboardMovementContext() {
     return useContext(context);
@@ -37,13 +37,12 @@ const returnNegative1 = ()=>-1;
  * Implements the custom keyboard movement behavior throughout react-md. Using
  * the "Find References" will be the best way to see example usage.
  *
- * @example
- * Default Keyboard Movement for any Focusable Element
+ * @example Default Keyboard Movement for any Focusable Element
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  *
  * function Example({ children }: { children: ReactNode }): ReactElement {
@@ -61,14 +60,13 @@ const returnNegative1 = ()=>-1;
  * }
  * ```
  *
- * @example
- * Active Descendant Movement
+ * @example Active Descendant Movement
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementContext,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  * import { useId } from "react";
  *
@@ -108,14 +106,13 @@ const returnNegative1 = ()=>-1;
  * }
  * ```
  *
- * @example
- * Roving Tab Index
+ * @example Roving Tab Index
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
  *   useKeyboardMovementContext,
  *   useKeyboardMovementProvider,
- * } from "@react-md/core";
+ * } from "@react-md/core/movement/useKeyboardMovementProvider";
  * import type { ReactElement, ReactNode } from "react";
  * import { useId } from "react";
  *
@@ -154,7 +151,7 @@ const returnNegative1 = ()=>-1;
  *   );
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function useKeyboardMovementProvider(options = {}) {
     const { onClick = noop, onFocus = noop, onKeyDown = noop, loopable = false, disabled, searchable = false, horizontal = false, includeDisabled = false, tabIndexBehavior, extendKeyDown = noop, onFocusChange = noop, programmatic = includeDisabled, incrementKeys: propIncrementKeys, decrementKeys: propDecrementKeys, jumpToFirstKeys: propJumpToFirstKeys, jumpToLastKeys: propJumpToLastKeys, getFocusableElements = defaultGetFocusableElements, getDefaultFocusedIndex = returnNegative1, isNegativeOneAllowed = false } = options;

package/dist/movement/useKeyboardMovementProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/movement/useKeyboardMovementProvider.ts"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n} from \"react\";\nimport { getFocusableElements as defaultGetFocusableElements } from \"../focus/utils.js\";\nimport { useUserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport { useDir } from \"../typography/WritingDirectionProvider.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport {\n  DEFAULT_KEYBOARD_MOVEMENT,\n  DEFAULT_LTR_KEYBOARD_MOVEMENT,\n  DEFAULT_RTL_KEYBOARD_MOVEMENT,\n} from \"./constants.js\";\nimport { findMatchIndex } from \"./findMatchIndex.js\";\nimport type {\n  KeyboardMovementConfig,\n  KeyboardMovementConfiguration,\n  KeyboardMovementContext,\n  KeyboardMovementProviderImplementation,\n  KeyboardMovementProviderOptions,\n} from \"./types.js\";\nimport {\n  getFirstFocusableIndex,\n  getLastFocusableIndex,\n  getNextFocusableIndex,\n  getSearchText,\n  getVirtualFocusDefaultIndex,\n  isElementDisabled,\n  isNotFocusable,\n  isSearchableEvent,\n  recalculateFocusIndex,\n} from \"./utils.js\";\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nconst context = createContext<KeyboardMovementContext>({\n  config: { current: DEFAULT_KEYBOARD_MOVEMENT },\n  loopable: false,\n  searchable: false,\n  horizontal: false,\n  includeDisabled: false,\n  tabIndexBehavior: undefined,\n  activeDescendantId: \"\",\n});\ncontext.displayName = \"KeyboardMovement\";\nexport const { Provider: KeyboardMovementProvider } = context;\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport function useKeyboardMovementContext(): Readonly<KeyboardMovementContext> {\n  return useContext(context);\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\nconst returnNegative1 = (): number => -1;\n\n/**\n * Implements the custom keyboard movement behavior throughout react-md. Using\n * the \"Find References\" will be the best way to see example usage.\n *\n * @example\n * Default Keyboard Movement for any Focusable Element\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core\";\n * import type { ReactElement, ReactNode } from \"react\";\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider();\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         {children}\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n *\n * @example\n * Active Descendant Movement\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementContext,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core\";\n * import type { ReactElement, ReactNode } from \"react\";\n * import { useId } from \"react\";\n *\n * function Child(): ReactElement {\n *   const id = useId()\n *   const { activeDescendantId } = useKeyboardMovementContext();\n *\n *   return (\n *     <div\n *       {...props}\n *       id={id}\n *       className={cnb(id === activeDescendantId && \"focused-class-name\")}\n *     >\n *       Some Content\n *     </div>\n *   );\n * }\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider({\n *     loopable: true,\n *     searchable: true,\n *     tabIndexBehavior: \"virtual\",\n *   });\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         <Child />\n *         <Child />\n *         <Child />\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n *\n * @example\n * Roving Tab Index\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementContext,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core\";\n * import type { ReactElement, ReactNode } from \"react\";\n * import { useId } from \"react\";\n *\n * function Child(): ReactElement {\n *   const id = useId()\n *   const { activeDescendantId } = useKeyboardMovementContext();\n *\n *   return (\n *     <div\n *       {...props}\n *       id={id}\n *       tabIndex={id === activeDescendantId ? 0 : -1}\n *     >\n *       Some Content\n *     </div>\n *   );\n * }\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider({\n *     loopable: true,\n *     searchable: true,\n *     tabIndexBehavior: \"roving\",\n *   });\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         <Child />\n *         <Child />\n *         <Child />\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function useKeyboardMovementProvider<E extends HTMLElement>(\n  options: KeyboardMovementProviderOptions<E> = {}\n): KeyboardMovementProviderImplementation<E> {\n  const {\n    onClick = noop,\n    onFocus = noop,\n    onKeyDown = noop,\n    loopable = false,\n    disabled,\n    searchable = false,\n    horizontal = false,\n    includeDisabled = false,\n    tabIndexBehavior,\n    extendKeyDown = noop,\n    onFocusChange = noop,\n    programmatic = includeDisabled,\n    incrementKeys: propIncrementKeys,\n    decrementKeys: propDecrementKeys,\n    jumpToFirstKeys: propJumpToFirstKeys,\n    jumpToLastKeys: propJumpToLastKeys,\n    getFocusableElements = defaultGetFocusableElements,\n    getDefaultFocusedIndex = returnNegative1,\n    isNegativeOneAllowed = false,\n  } = options;\n\n  const isRTL = useDir().dir === \"rtl\";\n  let defaults: Readonly<Required<KeyboardMovementConfiguration>>;\n  if (horizontal) {\n    defaults = isRTL\n      ? DEFAULT_RTL_KEYBOARD_MOVEMENT\n      : DEFAULT_LTR_KEYBOARD_MOVEMENT;\n  } else {\n    defaults = DEFAULT_KEYBOARD_MOVEMENT;\n  }\n\n  const incrementKeys = propIncrementKeys || defaults.incrementKeys;\n  const decrementKeys = propDecrementKeys || defaults.decrementKeys;\n  const jumpToFirstKeys = propJumpToFirstKeys || defaults.jumpToFirstKeys;\n  const jumpToLastKeys = propJumpToLastKeys || defaults.jumpToLastKeys;\n\n  const configuration: KeyboardMovementConfig = {\n    incrementKeys,\n    decrementKeys,\n    jumpToFirstKeys,\n    jumpToLastKeys,\n  };\n  const config = useRef(configuration);\n  useIsomorphicLayoutEffect(() => {\n    config.current = configuration;\n  });\n\n  const [activeDescendantId, setActiveDescendantId] = useState(\"\");\n  const movementContext = useMemo<KeyboardMovementContext>(\n    () => ({\n      config,\n      loopable,\n      searchable,\n      horizontal,\n      includeDisabled,\n      tabIndexBehavior,\n      activeDescendantId,\n    }),\n    [\n      activeDescendantId,\n      horizontal,\n      includeDisabled,\n      loopable,\n      searchable,\n      tabIndexBehavior,\n    ]\n  );\n  const currentFocusIndex = useRef(-1);\n  const mode = useUserInteractionMode();\n  const refocus = useRef(false);\n\n  if (process.env.NODE_ENV !== \"production\") {\n    // this fixes issues during hot reloading and using the `useId()` hook\n    // eslint-disable-next-line react-hooks/rules-of-hooks\n    useEffect(() => {\n      return () => {\n        setActiveDescendantId(\"\");\n      };\n    }, []);\n  }\n\n  let tabIndex: number | undefined;\n  if (tabIndexBehavior) {\n    tabIndex =\n      disabled || (tabIndexBehavior === \"roving\" && activeDescendantId)\n        ? -1\n        : 0;\n  }\n\n  return {\n    movementProps: {\n      \"aria-activedescendant\":\n        tabIndexBehavior === \"virtual\" ? activeDescendantId : undefined,\n      tabIndex,\n\n      // Note: This used to be on the `onFocus` event, but this causes issues in\n      // Chromium browsers for drag and drop behavior\n      onClick(event) {\n        onClick(event);\n        if (disabled) {\n          return;\n        }\n\n        // This makes it so you can click an element with a mouse and then\n        // keyboard navigate from that element instead of the last keyboard focus\n        // element\n        const { currentTarget, target } = event;\n        if (target === currentTarget || !(target instanceof HTMLElement)) {\n          return;\n        }\n\n        const focusables = getFocusableElements(currentTarget, programmatic);\n        const focusedIndex = focusables.findIndex(\n          (element) => element === target || element.contains(target)\n        );\n        if (focusedIndex === -1 || !focusables.length) {\n          return;\n        }\n\n        currentFocusIndex.current = focusedIndex;\n        const focused = focusables[focusedIndex];\n        if (tabIndexBehavior) {\n          setActiveDescendantId(focused.id);\n        }\n\n        // need to force focus back to the container element when using\n        // aria activedescendant\n        if (tabIndexBehavior === \"virtual\") {\n          refocus.current = true;\n          currentTarget.focus();\n        }\n\n        onFocusChange({\n          index: focusedIndex,\n          element: focused,\n        });\n      },\n      onFocus(event) {\n        onFocus(event);\n        if (event.isPropagationStopped() || refocus.current) {\n          refocus.current = false;\n          return;\n        }\n\n        if (\n          (mode !== \"keyboard\" && tabIndexBehavior !== \"virtual\") ||\n          event.target !== event.currentTarget\n        ) {\n          return;\n        }\n\n        const focusables = getFocusableElements(\n          event.currentTarget,\n          programmatic\n        );\n        if (!focusables.length) {\n          return;\n        }\n\n        let defaultFocusIndex = getDefaultFocusedIndex({\n          focusables,\n          includeDisabled,\n        });\n\n        // This allows my custom `getDefaultFocusedIndex` implementations to\n        // have a nice fallback without having to re-implement the \"focus\n        // first\" behavior\n        if (!isNegativeOneAllowed && defaultFocusIndex === -1) {\n          if (tabIndexBehavior === \"virtual\") {\n            // virtual keyboard navigation **must** always focus at least one element\n            defaultFocusIndex = getVirtualFocusDefaultIndex({\n              focusables,\n              includeDisabled,\n              activeDescendantId,\n            });\n          } else {\n            defaultFocusIndex = getFirstFocusableIndex({\n              focusables,\n              includeDisabled,\n            });\n          }\n        }\n\n        if (defaultFocusIndex === -1) {\n          return;\n        }\n\n        currentFocusIndex.current = defaultFocusIndex;\n        const focused = focusables[defaultFocusIndex];\n        if (tabIndexBehavior) {\n          setActiveDescendantId(focused.id);\n        }\n\n        if (tabIndexBehavior !== \"virtual\") {\n          focused.focus();\n        } else {\n          focused.scrollIntoView({ block: \"nearest\" });\n        }\n\n        onFocusChange({\n          index: defaultFocusIndex,\n          element: focused,\n        });\n      },\n      onKeyDown(event) {\n        onKeyDown(event);\n        if (disabled) {\n          return;\n        }\n\n        const { currentTarget } = event;\n\n        const setFocusIndex = (\n          index: number,\n          focusables: readonly HTMLElement[]\n        ): void => {\n          event.preventDefault();\n          event.stopPropagation();\n          if (currentFocusIndex.current === index || index === -1) {\n            return;\n          }\n\n          currentFocusIndex.current = index;\n          const focused = focusables[index];\n          if (tabIndexBehavior) {\n            focused.scrollIntoView({\n              block: \"nearest\",\n              inline: \"nearest\",\n            });\n            setActiveDescendantId(focused.id);\n          }\n\n          if (tabIndexBehavior !== \"virtual\") {\n            focused.focus();\n          }\n\n          onFocusChange({\n            index,\n            element: focused,\n          });\n        };\n\n        extendKeyDown({\n          event,\n          setFocusIndex,\n          currentFocusIndex,\n          setActiveDescendantId,\n          ...movementContext,\n        });\n\n        if (event.isPropagationStopped()) {\n          return;\n        }\n\n        // TODO: Figure this part out. This is currently required for the tree\n        // movement when the asterisk key is pressed. There might be other cases\n        // as well.\n        if (!isNegativeOneAllowed && currentFocusIndex.current === -1) {\n          currentFocusIndex.current = recalculateFocusIndex({\n            focusables: getFocusableElements(currentTarget, programmatic),\n            includeDisabled,\n            tabIndexBehavior,\n            activeDescendantId,\n          });\n        }\n\n        const { key, shiftKey } = event;\n        if (\n          tabIndexBehavior === \"virtual\" &&\n          activeDescendantId &&\n          (key === \" \" || key === \"Enter\")\n        ) {\n          if (key === \" \") {\n            event.preventDefault();\n          }\n\n          const focusables = getFocusableElements(currentTarget, programmatic);\n          const activeElement = focusables[currentFocusIndex.current];\n          if (!activeElement || isElementDisabled(activeElement)) {\n            return;\n          }\n\n          activeElement.click();\n          return;\n        }\n\n        const {\n          incrementKeys,\n          decrementKeys,\n          jumpToFirstKeys,\n          jumpToLastKeys,\n        } = config.current;\n\n        if (searchable && isSearchableEvent(event)) {\n          const focusables = getFocusableElements(currentTarget, programmatic);\n          const index = findMatchIndex({\n            value: key,\n            values: focusables.map((element) =>\n              getSearchText(element, !isNotFocusable(element, includeDisabled))\n            ),\n            startIndex: shiftKey ? -1 : currentFocusIndex.current,\n          });\n          setFocusIndex(index, focusables);\n          return;\n        }\n\n        const jumpToFirst = jumpToFirstKeys.includes(key);\n        const jumpToLast = !jumpToFirst && jumpToLastKeys.includes(key);\n        const increment =\n          !jumpToFirst && !jumpToLast && incrementKeys.includes(key);\n        const decrement =\n          !jumpToFirst &&\n          !jumpToLast &&\n          !increment &&\n          decrementKeys.includes(key);\n\n        if (!jumpToFirst && !jumpToLast && !increment && !decrement) {\n          return;\n        }\n        const focusables = getFocusableElements(currentTarget, programmatic);\n\n        let index: number;\n        if (jumpToFirst) {\n          index = getFirstFocusableIndex({\n            focusables,\n            includeDisabled,\n          });\n        } else if (jumpToLast) {\n          index = getLastFocusableIndex({\n            focusables,\n            includeDisabled,\n          });\n        } else {\n          index = getNextFocusableIndex({\n            loopable,\n            increment,\n            focusables,\n            includeDisabled,\n            currentFocusIndex: currentFocusIndex.current,\n          });\n        }\n\n        setFocusIndex(index, focusables);\n      },\n    },\n    movementContext,\n    currentFocusIndex,\n    activeDescendantId,\n    setActiveDescendantId,\n  };\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useRef","useState","getFocusableElements","defaultGetFocusableElements","useUserInteractionMode","useDir","useIsomorphicLayoutEffect","DEFAULT_KEYBOARD_MOVEMENT","DEFAULT_LTR_KEYBOARD_MOVEMENT","DEFAULT_RTL_KEYBOARD_MOVEMENT","findMatchIndex","getFirstFocusableIndex","getLastFocusableIndex","getNextFocusableIndex","getSearchText","getVirtualFocusDefaultIndex","isElementDisabled","isNotFocusable","isSearchableEvent","recalculateFocusIndex","context","config","current","loopable","searchable","horizontal","includeDisabled","tabIndexBehavior","undefined","activeDescendantId","displayName","Provider","KeyboardMovementProvider","useKeyboardMovementContext","noop","returnNegative1","useKeyboardMovementProvider","options","onClick","onFocus","onKeyDown","disabled","extendKeyDown","onFocusChange","programmatic","incrementKeys","propIncrementKeys","decrementKeys","propDecrementKeys","jumpToFirstKeys","propJumpToFirstKeys","jumpToLastKeys","propJumpToLastKeys","getDefaultFocusedIndex","isNegativeOneAllowed","isRTL","dir","defaults","configuration","setActiveDescendantId","movementContext","currentFocusIndex","mode","refocus","process","env","NODE_ENV","tabIndex","movementProps","event","currentTarget","target","HTMLElement","focusables","focusedIndex","findIndex","element","contains","length","focused","id","focus","index","isPropagationStopped","defaultFocusIndex","scrollIntoView","block","setFocusIndex","preventDefault","stopPropagation","inline","key","shiftKey","activeElement","click","value","values","map","startIndex","jumpToFirst","includes","jumpToLast","increment","decrement"],"mappings":"AAAA;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,QAAQ;AACf,SAASC,wBAAwBC,2BAA2B,QAAQ,oBAAoB;AACxF,SAASC,sBAAsB,QAAQ,gDAAgD;AACvF,SAASC,MAAM,QAAQ,4CAA4C;AACnE,SAASC,yBAAyB,QAAQ,kCAAkC;AAC5E,SACEC,yBAAyB,EACzBC,6BAA6B,EAC7BC,6BAA6B,QACxB,iBAAiB;AACxB,SAASC,cAAc,QAAQ,sBAAsB;AAQrD,SACEC,sBAAsB,EACtBC,qBAAqB,EACrBC,qBAAqB,EACrBC,aAAa,EACbC,2BAA2B,EAC3BC,iBAAiB,EACjBC,cAAc,EACdC,iBAAiB,EACjBC,qBAAqB,QAChB,aAAa;AAEpB;;;CAGC,GACD,MAAMC,UAAUxB,cAAuC;IACrDyB,QAAQ;QAAEC,SAASf;IAA0B;IAC7CgB,UAAU;IACVC,YAAY;IACZC,YAAY;IACZC,iBAAiB;IACjBC,kBAAkBC;IAClBC,oBAAoB;AACtB;AACAT,QAAQU,WAAW,GAAG;AACtB,OAAO,MAAM,EAAEC,UAAUC,wBAAwB,EAAE,GAAGZ,QAAQ;AAE9D;;;CAGC,GACD,OAAO,SAASa;IACd,OAAOpC,WAAWuB;AACpB;AAEA,MAAMc,OAAO;AACX,aAAa;AACf;AAEA,MAAMC,kBAAkB,IAAc,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2HC,GACD,OAAO,SAASC,4BACdC,UAA8C,CAAC,CAAC;IAEhD,MAAM,EACJC,UAAUJ,IAAI,EACdK,UAAUL,IAAI,EACdM,YAAYN,IAAI,EAChBX,WAAW,KAAK,EAChBkB,QAAQ,EACRjB,aAAa,KAAK,EAClBC,aAAa,KAAK,EAClBC,kBAAkB,KAAK,EACvBC,gBAAgB,EAChBe,gBAAgBR,IAAI,EACpBS,gBAAgBT,IAAI,EACpBU,eAAelB,eAAe,EAC9BmB,eAAeC,iBAAiB,EAChCC,eAAeC,iBAAiB,EAChCC,iBAAiBC,mBAAmB,EACpCC,gBAAgBC,kBAAkB,EAClClD,uBAAuBC,2BAA2B,EAClDkD,yBAAyBlB,eAAe,EACxCmB,uBAAuB,KAAK,EAC7B,GAAGjB;IAEJ,MAAMkB,QAAQlD,SAASmD,GAAG,KAAK;IAC/B,IAAIC;IACJ,IAAIhC,YAAY;QACdgC,WAAWF,QACP9C,gCACAD;IACN,OAAO;QACLiD,WAAWlD;IACb;IAEA,MAAMsC,gBAAgBC,qBAAqBW,SAASZ,aAAa;IACjE,MAAME,gBAAgBC,qBAAqBS,SAASV,aAAa;IACjE,MAAME,kBAAkBC,uBAAuBO,SAASR,eAAe;IACvE,MAAME,iBAAiBC,sBAAsBK,SAASN,cAAc;IAEpE,MAAMO,gBAAwC;QAC5Cb;QACAE;QACAE;QACAE;IACF;IACA,MAAM9B,SAASrB,OAAO0D;IACtBpD,0BAA0B;QACxBe,OAAOC,OAAO,GAAGoC;IACnB;IAEA,MAAM,CAAC7B,oBAAoB8B,sBAAsB,GAAG1D,SAAS;IAC7D,MAAM2D,kBAAkB7D,QACtB,IAAO,CAAA;YACLsB;YACAE;YACAC;YACAC;YACAC;YACAC;YACAE;QACF,CAAA,GACA;QACEA;QACAJ;QACAC;QACAH;QACAC;QACAG;KACD;IAEH,MAAMkC,oBAAoB7D,OAAO,CAAC;IAClC,MAAM8D,OAAO1D;IACb,MAAM2D,UAAU/D,OAAO;IAEvB,IAAIgE,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,sEAAsE;QACtE,sDAAsD;QACtDpE,UAAU;YACR,OAAO;gBACL6D,sBAAsB;YACxB;QACF,GAAG,EAAE;IACP;IAEA,IAAIQ;IACJ,IAAIxC,kBAAkB;QACpBwC,WACE1B,YAAad,qBAAqB,YAAYE,qBAC1C,CAAC,IACD;IACR;IAEA,OAAO;QACLuC,eAAe;YACb,yBACEzC,qBAAqB,YAAYE,qBAAqBD;YACxDuC;YAEA,0EAA0E;YAC1E,+CAA+C;YAC/C7B,SAAQ+B,KAAK;gBACX/B,QAAQ+B;gBACR,IAAI5B,UAAU;oBACZ;gBACF;gBAEA,kEAAkE;gBAClE,yEAAyE;gBACzE,UAAU;gBACV,MAAM,EAAE6B,aAAa,EAAEC,MAAM,EAAE,GAAGF;gBAClC,IAAIE,WAAWD,iBAAiB,CAAEC,CAAAA,kBAAkBC,WAAU,GAAI;oBAChE;gBACF;gBAEA,MAAMC,aAAavE,qBAAqBoE,eAAe1B;gBACvD,MAAM8B,eAAeD,WAAWE,SAAS,CACvC,CAACC,UAAYA,YAAYL,UAAUK,QAAQC,QAAQ,CAACN;gBAEtD,IAAIG,iBAAiB,CAAC,KAAK,CAACD,WAAWK,MAAM,EAAE;oBAC7C;gBACF;gBAEAjB,kBAAkBvC,OAAO,GAAGoD;gBAC5B,MAAMK,UAAUN,UAAU,CAACC,aAAa;gBACxC,IAAI/C,kBAAkB;oBACpBgC,sBAAsBoB,QAAQC,EAAE;gBAClC;gBAEA,+DAA+D;gBAC/D,wBAAwB;gBACxB,IAAIrD,qBAAqB,WAAW;oBAClCoC,QAAQzC,OAAO,GAAG;oBAClBgD,cAAcW,KAAK;gBACrB;gBAEAtC,cAAc;oBACZuC,OAAOR;oBACPE,SAASG;gBACX;YACF;YACAxC,SAAQ8B,KAAK;gBACX9B,QAAQ8B;gBACR,IAAIA,MAAMc,oBAAoB,MAAMpB,QAAQzC,OAAO,EAAE;oBACnDyC,QAAQzC,OAAO,GAAG;oBAClB;gBACF;gBAEA,IACE,AAACwC,SAAS,cAAcnC,qBAAqB,aAC7C0C,MAAME,MAAM,KAAKF,MAAMC,aAAa,EACpC;oBACA;gBACF;gBAEA,MAAMG,aAAavE,qBACjBmE,MAAMC,aAAa,EACnB1B;gBAEF,IAAI,CAAC6B,WAAWK,MAAM,EAAE;oBACtB;gBACF;gBAEA,IAAIM,oBAAoB/B,uBAAuB;oBAC7CoB;oBACA/C;gBACF;gBAEA,oEAAoE;gBACpE,iEAAiE;gBACjE,kBAAkB;gBAClB,IAAI,CAAC4B,wBAAwB8B,sBAAsB,CAAC,GAAG;oBACrD,IAAIzD,qBAAqB,WAAW;wBAClC,yEAAyE;wBACzEyD,oBAAoBrE,4BAA4B;4BAC9C0D;4BACA/C;4BACAG;wBACF;oBACF,OAAO;wBACLuD,oBAAoBzE,uBAAuB;4BACzC8D;4BACA/C;wBACF;oBACF;gBACF;gBAEA,IAAI0D,sBAAsB,CAAC,GAAG;oBAC5B;gBACF;gBAEAvB,kBAAkBvC,OAAO,GAAG8D;gBAC5B,MAAML,UAAUN,UAAU,CAACW,kBAAkB;gBAC7C,IAAIzD,kBAAkB;oBACpBgC,sBAAsBoB,QAAQC,EAAE;gBAClC;gBAEA,IAAIrD,qBAAqB,WAAW;oBAClCoD,QAAQE,KAAK;gBACf,OAAO;oBACLF,QAAQM,cAAc,CAAC;wBAAEC,OAAO;oBAAU;gBAC5C;gBAEA3C,cAAc;oBACZuC,OAAOE;oBACPR,SAASG;gBACX;YACF;YACAvC,WAAU6B,KAAK;gBACb7B,UAAU6B;gBACV,IAAI5B,UAAU;oBACZ;gBACF;gBAEA,MAAM,EAAE6B,aAAa,EAAE,GAAGD;gBAE1B,MAAMkB,gBAAgB,CACpBL,OACAT;oBAEAJ,MAAMmB,cAAc;oBACpBnB,MAAMoB,eAAe;oBACrB,IAAI5B,kBAAkBvC,OAAO,KAAK4D,SAASA,UAAU,CAAC,GAAG;wBACvD;oBACF;oBAEArB,kBAAkBvC,OAAO,GAAG4D;oBAC5B,MAAMH,UAAUN,UAAU,CAACS,MAAM;oBACjC,IAAIvD,kBAAkB;wBACpBoD,QAAQM,cAAc,CAAC;4BACrBC,OAAO;4BACPI,QAAQ;wBACV;wBACA/B,sBAAsBoB,QAAQC,EAAE;oBAClC;oBAEA,IAAIrD,qBAAqB,WAAW;wBAClCoD,QAAQE,KAAK;oBACf;oBAEAtC,cAAc;wBACZuC;wBACAN,SAASG;oBACX;gBACF;gBAEArC,cAAc;oBACZ2B;oBACAkB;oBACA1B;oBACAF;oBACA,GAAGC,eAAe;gBACpB;gBAEA,IAAIS,MAAMc,oBAAoB,IAAI;oBAChC;gBACF;gBAEA,sEAAsE;gBACtE,wEAAwE;gBACxE,WAAW;gBACX,IAAI,CAAC7B,wBAAwBO,kBAAkBvC,OAAO,KAAK,CAAC,GAAG;oBAC7DuC,kBAAkBvC,OAAO,GAAGH,sBAAsB;wBAChDsD,YAAYvE,qBAAqBoE,eAAe1B;wBAChDlB;wBACAC;wBACAE;oBACF;gBACF;gBAEA,MAAM,EAAE8D,GAAG,EAAEC,QAAQ,EAAE,GAAGvB;gBAC1B,IACE1C,qBAAqB,aACrBE,sBACC8D,CAAAA,QAAQ,OAAOA,QAAQ,OAAM,GAC9B;oBACA,IAAIA,QAAQ,KAAK;wBACftB,MAAMmB,cAAc;oBACtB;oBAEA,MAAMf,aAAavE,qBAAqBoE,eAAe1B;oBACvD,MAAMiD,gBAAgBpB,UAAU,CAACZ,kBAAkBvC,OAAO,CAAC;oBAC3D,IAAI,CAACuE,iBAAiB7E,kBAAkB6E,gBAAgB;wBACtD;oBACF;oBAEAA,cAAcC,KAAK;oBACnB;gBACF;gBAEA,MAAM,EACJjD,aAAa,EACbE,aAAa,EACbE,eAAe,EACfE,cAAc,EACf,GAAG9B,OAAOC,OAAO;gBAElB,IAAIE,cAAcN,kBAAkBmD,QAAQ;oBAC1C,MAAMI,aAAavE,qBAAqBoE,eAAe1B;oBACvD,MAAMsC,QAAQxE,eAAe;wBAC3BqF,OAAOJ;wBACPK,QAAQvB,WAAWwB,GAAG,CAAC,CAACrB,UACtB9D,cAAc8D,SAAS,CAAC3D,eAAe2D,SAASlD;wBAElDwE,YAAYN,WAAW,CAAC,IAAI/B,kBAAkBvC,OAAO;oBACvD;oBACAiE,cAAcL,OAAOT;oBACrB;gBACF;gBAEA,MAAM0B,cAAclD,gBAAgBmD,QAAQ,CAACT;gBAC7C,MAAMU,aAAa,CAACF,eAAehD,eAAeiD,QAAQ,CAACT;gBAC3D,MAAMW,YACJ,CAACH,eAAe,CAACE,cAAcxD,cAAcuD,QAAQ,CAACT;gBACxD,MAAMY,YACJ,CAACJ,eACD,CAACE,cACD,CAACC,aACDvD,cAAcqD,QAAQ,CAACT;gBAEzB,IAAI,CAACQ,eAAe,CAACE,cAAc,CAACC,aAAa,CAACC,WAAW;oBAC3D;gBACF;gBACA,MAAM9B,aAAavE,qBAAqBoE,eAAe1B;gBAEvD,IAAIsC;gBACJ,IAAIiB,aAAa;oBACfjB,QAAQvE,uBAAuB;wBAC7B8D;wBACA/C;oBACF;gBACF,OAAO,IAAI2E,YAAY;oBACrBnB,QAAQtE,sBAAsB;wBAC5B6D;wBACA/C;oBACF;gBACF,OAAO;oBACLwD,QAAQrE,sBAAsB;wBAC5BU;wBACA+E;wBACA7B;wBACA/C;wBACAmC,mBAAmBA,kBAAkBvC,OAAO;oBAC9C;gBACF;gBAEAiE,cAAcL,OAAOT;YACvB;QACF;QACAb;QACAC;QACAhC;QACA8B;IACF;AACF"}
+{"version":3,"sources":["../../src/movement/useKeyboardMovementProvider.ts"],"sourcesContent":["\"use client\";\n\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n} from \"react\";\n\nimport { getFocusableElements as defaultGetFocusableElements } from \"../focus/utils.js\";\nimport { useUserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport { useDir } from \"../typography/WritingDirectionProvider.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport {\n  DEFAULT_KEYBOARD_MOVEMENT,\n  DEFAULT_LTR_KEYBOARD_MOVEMENT,\n  DEFAULT_RTL_KEYBOARD_MOVEMENT,\n} from \"./constants.js\";\nimport { findMatchIndex } from \"./findMatchIndex.js\";\nimport type {\n  KeyboardMovementConfig,\n  KeyboardMovementConfiguration,\n  KeyboardMovementContext,\n  KeyboardMovementProviderImplementation,\n  KeyboardMovementProviderOptions,\n} from \"./types.js\";\nimport {\n  getFirstFocusableIndex,\n  getLastFocusableIndex,\n  getNextFocusableIndex,\n  getSearchText,\n  getVirtualFocusDefaultIndex,\n  isElementDisabled,\n  isNotFocusable,\n  isSearchableEvent,\n  recalculateFocusIndex,\n} from \"./utils.js\";\n\n/**\n * @since 5.0.0\n * @internal\n */\nconst context = createContext<KeyboardMovementContext>({\n  config: { current: DEFAULT_KEYBOARD_MOVEMENT },\n  loopable: false,\n  searchable: false,\n  horizontal: false,\n  includeDisabled: false,\n  tabIndexBehavior: undefined,\n  activeDescendantId: \"\",\n});\ncontext.displayName = \"KeyboardMovement\";\nexport const { Provider: KeyboardMovementProvider } = context;\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport function useKeyboardMovementContext(): Readonly<KeyboardMovementContext> {\n  return useContext(context);\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\nconst returnNegative1 = (): number => -1;\n\n/**\n * Implements the custom keyboard movement behavior throughout react-md. Using\n * the \"Find References\" will be the best way to see example usage.\n *\n * @example Default Keyboard Movement for any Focusable Element\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core/movement/useKeyboardMovementProvider\";\n * import type { ReactElement, ReactNode } from \"react\";\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider();\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         {children}\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n *\n * @example Active Descendant Movement\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementContext,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core/movement/useKeyboardMovementProvider\";\n * import type { ReactElement, ReactNode } from \"react\";\n * import { useId } from \"react\";\n *\n * function Child(): ReactElement {\n *   const id = useId()\n *   const { activeDescendantId } = useKeyboardMovementContext();\n *\n *   return (\n *     <div\n *       {...props}\n *       id={id}\n *       className={cnb(id === activeDescendantId && \"focused-class-name\")}\n *     >\n *       Some Content\n *     </div>\n *   );\n * }\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider({\n *     loopable: true,\n *     searchable: true,\n *     tabIndexBehavior: \"virtual\",\n *   });\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         <Child />\n *         <Child />\n *         <Child />\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n *\n * @example Roving Tab Index\n * ```tsx\n * import {\n *   KeyboardMovementProvider,\n *   useKeyboardMovementContext,\n *   useKeyboardMovementProvider,\n * } from \"@react-md/core/movement/useKeyboardMovementProvider\";\n * import type { ReactElement, ReactNode } from \"react\";\n * import { useId } from \"react\";\n *\n * function Child(): ReactElement {\n *   const id = useId()\n *   const { activeDescendantId } = useKeyboardMovementContext();\n *\n *   return (\n *     <div\n *       {...props}\n *       id={id}\n *       tabIndex={id === activeDescendantId ? 0 : -1}\n *     >\n *       Some Content\n *     </div>\n *   );\n * }\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const { movementContext, movementProps } = useKeyboardMovementProvider({\n *     loopable: true,\n *     searchable: true,\n *     tabIndexBehavior: \"roving\",\n *   });\n *\n *   // any focusable element child can be focused with the arrow , home, and\n *   // end keys\n *   return (\n *     <KeyboardMovementProvider value={movementContext}>\n *       <div {...movementProps}>\n *         <Child />\n *         <Child />\n *         <Child />\n *       </div>\n *     </KeyboardMovementProvider>\n *   );\n * }\n * ```\n * @since 6.0.0\n * @internal\n */\nexport function useKeyboardMovementProvider<E extends HTMLElement>(\n  options: KeyboardMovementProviderOptions<E> = {}\n): KeyboardMovementProviderImplementation<E> {\n  const {\n    onClick = noop,\n    onFocus = noop,\n    onKeyDown = noop,\n    loopable = false,\n    disabled,\n    searchable = false,\n    horizontal = false,\n    includeDisabled = false,\n    tabIndexBehavior,\n    extendKeyDown = noop,\n    onFocusChange = noop,\n    programmatic = includeDisabled,\n    incrementKeys: propIncrementKeys,\n    decrementKeys: propDecrementKeys,\n    jumpToFirstKeys: propJumpToFirstKeys,\n    jumpToLastKeys: propJumpToLastKeys,\n    getFocusableElements = defaultGetFocusableElements,\n    getDefaultFocusedIndex = returnNegative1,\n    isNegativeOneAllowed = false,\n  } = options;\n\n  const isRTL = useDir().dir === \"rtl\";\n  let defaults: Readonly<Required<KeyboardMovementConfiguration>>;\n  if (horizontal) {\n    defaults = isRTL\n      ? DEFAULT_RTL_KEYBOARD_MOVEMENT\n      : DEFAULT_LTR_KEYBOARD_MOVEMENT;\n  } else {\n    defaults = DEFAULT_KEYBOARD_MOVEMENT;\n  }\n\n  const incrementKeys = propIncrementKeys || defaults.incrementKeys;\n  const decrementKeys = propDecrementKeys || defaults.decrementKeys;\n  const jumpToFirstKeys = propJumpToFirstKeys || defaults.jumpToFirstKeys;\n  const jumpToLastKeys = propJumpToLastKeys || defaults.jumpToLastKeys;\n\n  const configuration: KeyboardMovementConfig = {\n    incrementKeys,\n    decrementKeys,\n    jumpToFirstKeys,\n    jumpToLastKeys,\n  };\n  const config = useRef(configuration);\n  useIsomorphicLayoutEffect(() => {\n    config.current = configuration;\n  });\n\n  const [activeDescendantId, setActiveDescendantId] = useState(\"\");\n  const movementContext = useMemo<KeyboardMovementContext>(\n    () => ({\n      config,\n      loopable,\n      searchable,\n      horizontal,\n      includeDisabled,\n      tabIndexBehavior,\n      activeDescendantId,\n    }),\n    [\n      activeDescendantId,\n      horizontal,\n      includeDisabled,\n      loopable,\n      searchable,\n      tabIndexBehavior,\n    ]\n  );\n  const currentFocusIndex = useRef(-1);\n  const mode = useUserInteractionMode();\n  const refocus = useRef(false);\n\n  if (process.env.NODE_ENV !== \"production\") {\n    // this fixes issues during hot reloading and using the `useId()` hook\n    // eslint-disable-next-line react-hooks/rules-of-hooks\n    useEffect(() => {\n      return () => {\n        setActiveDescendantId(\"\");\n      };\n    }, []);\n  }\n\n  let tabIndex: number | undefined;\n  if (tabIndexBehavior) {\n    tabIndex =\n      disabled || (tabIndexBehavior === \"roving\" && activeDescendantId)\n        ? -1\n        : 0;\n  }\n\n  return {\n    movementProps: {\n      \"aria-activedescendant\":\n        tabIndexBehavior === \"virtual\" ? activeDescendantId : undefined,\n      tabIndex,\n\n      // Note: This used to be on the `onFocus` event, but this causes issues in\n      // Chromium browsers for drag and drop behavior\n      onClick(event) {\n        onClick(event);\n        if (disabled) {\n          return;\n        }\n\n        // This makes it so you can click an element with a mouse and then\n        // keyboard navigate from that element instead of the last keyboard focus\n        // element\n        const { currentTarget, target } = event;\n        if (target === currentTarget || !(target instanceof HTMLElement)) {\n          return;\n        }\n\n        const focusables = getFocusableElements(currentTarget, programmatic);\n        const focusedIndex = focusables.findIndex(\n          (element) => element === target || element.contains(target)\n        );\n        if (focusedIndex === -1 || !focusables.length) {\n          return;\n        }\n\n        currentFocusIndex.current = focusedIndex;\n        const focused = focusables[focusedIndex];\n        if (tabIndexBehavior) {\n          setActiveDescendantId(focused.id);\n        }\n\n        // need to force focus back to the container element when using\n        // aria activedescendant\n        if (tabIndexBehavior === \"virtual\") {\n          refocus.current = true;\n          currentTarget.focus();\n        }\n\n        onFocusChange({\n          index: focusedIndex,\n          element: focused,\n        });\n      },\n      onFocus(event) {\n        onFocus(event);\n        if (event.isPropagationStopped() || refocus.current) {\n          refocus.current = false;\n          return;\n        }\n\n        if (\n          (mode !== \"keyboard\" && tabIndexBehavior !== \"virtual\") ||\n          event.target !== event.currentTarget\n        ) {\n          return;\n        }\n\n        const focusables = getFocusableElements(\n          event.currentTarget,\n          programmatic\n        );\n        if (!focusables.length) {\n          return;\n        }\n\n        let defaultFocusIndex = getDefaultFocusedIndex({\n          focusables,\n          includeDisabled,\n        });\n\n        // This allows my custom `getDefaultFocusedIndex` implementations to\n        // have a nice fallback without having to re-implement the \"focus\n        // first\" behavior\n        if (!isNegativeOneAllowed && defaultFocusIndex === -1) {\n          if (tabIndexBehavior === \"virtual\") {\n            // virtual keyboard navigation **must** always focus at least one element\n            defaultFocusIndex = getVirtualFocusDefaultIndex({\n              focusables,\n              includeDisabled,\n              activeDescendantId,\n            });\n          } else {\n            defaultFocusIndex = getFirstFocusableIndex({\n              focusables,\n              includeDisabled,\n            });\n          }\n        }\n\n        if (defaultFocusIndex === -1) {\n          return;\n        }\n\n        currentFocusIndex.current = defaultFocusIndex;\n        const focused = focusables[defaultFocusIndex];\n        if (tabIndexBehavior) {\n          setActiveDescendantId(focused.id);\n        }\n\n        if (tabIndexBehavior !== \"virtual\") {\n          focused.focus();\n        } else {\n          focused.scrollIntoView({ block: \"nearest\" });\n        }\n\n        onFocusChange({\n          index: defaultFocusIndex,\n          element: focused,\n        });\n      },\n      onKeyDown(event) {\n        onKeyDown(event);\n        if (disabled) {\n          return;\n        }\n\n        const { currentTarget } = event;\n\n        const setFocusIndex = (\n          index: number,\n          focusables: readonly HTMLElement[]\n        ): void => {\n          event.preventDefault();\n          event.stopPropagation();\n          if (currentFocusIndex.current === index || index === -1) {\n            return;\n          }\n\n          currentFocusIndex.current = index;\n          const focused = focusables[index];\n          if (tabIndexBehavior) {\n            focused.scrollIntoView({\n              block: \"nearest\",\n              inline: \"nearest\",\n            });\n            setActiveDescendantId(focused.id);\n          }\n\n          if (tabIndexBehavior !== \"virtual\") {\n            focused.focus();\n          }\n\n          onFocusChange({\n            index,\n            element: focused,\n          });\n        };\n\n        extendKeyDown({\n          event,\n          setFocusIndex,\n          currentFocusIndex,\n          setActiveDescendantId,\n          ...movementContext,\n        });\n\n        if (event.isPropagationStopped()) {\n          return;\n        }\n\n        // TODO: Figure this part out. This is currently required for the tree\n        // movement when the asterisk key is pressed. There might be other cases\n        // as well.\n        if (!isNegativeOneAllowed && currentFocusIndex.current === -1) {\n          currentFocusIndex.current = recalculateFocusIndex({\n            focusables: getFocusableElements(currentTarget, programmatic),\n            includeDisabled,\n            tabIndexBehavior,\n            activeDescendantId,\n          });\n        }\n\n        const { key, shiftKey } = event;\n        if (\n          tabIndexBehavior === \"virtual\" &&\n          activeDescendantId &&\n          (key === \" \" || key === \"Enter\")\n        ) {\n          if (key === \" \") {\n            event.preventDefault();\n          }\n\n          const focusables = getFocusableElements(currentTarget, programmatic);\n          const activeElement = focusables[currentFocusIndex.current];\n          if (!activeElement || isElementDisabled(activeElement)) {\n            return;\n          }\n\n          activeElement.click();\n          return;\n        }\n\n        const {\n          incrementKeys,\n          decrementKeys,\n          jumpToFirstKeys,\n          jumpToLastKeys,\n        } = config.current;\n\n        if (searchable && isSearchableEvent(event)) {\n          const focusables = getFocusableElements(currentTarget, programmatic);\n          const index = findMatchIndex({\n            value: key,\n            values: focusables.map((element) =>\n              getSearchText(element, !isNotFocusable(element, includeDisabled))\n            ),\n            startIndex: shiftKey ? -1 : currentFocusIndex.current,\n          });\n          setFocusIndex(index, focusables);\n          return;\n        }\n\n        const jumpToFirst = jumpToFirstKeys.includes(key);\n        const jumpToLast = !jumpToFirst && jumpToLastKeys.includes(key);\n        const increment =\n          !jumpToFirst && !jumpToLast && incrementKeys.includes(key);\n        const decrement =\n          !jumpToFirst &&\n          !jumpToLast &&\n          !increment &&\n          decrementKeys.includes(key);\n\n        if (!jumpToFirst && !jumpToLast && !increment && !decrement) {\n          return;\n        }\n        const focusables = getFocusableElements(currentTarget, programmatic);\n\n        let index: number;\n        if (jumpToFirst) {\n          index = getFirstFocusableIndex({\n            focusables,\n            includeDisabled,\n          });\n        } else if (jumpToLast) {\n          index = getLastFocusableIndex({\n            focusables,\n            includeDisabled,\n          });\n        } else {\n          index = getNextFocusableIndex({\n            loopable,\n            increment,\n            focusables,\n            includeDisabled,\n            currentFocusIndex: currentFocusIndex.current,\n          });\n        }\n\n        setFocusIndex(index, focusables);\n      },\n    },\n    movementContext,\n    currentFocusIndex,\n    activeDescendantId,\n    setActiveDescendantId,\n  };\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useRef","useState","getFocusableElements","defaultGetFocusableElements","useUserInteractionMode","useDir","useIsomorphicLayoutEffect","DEFAULT_KEYBOARD_MOVEMENT","DEFAULT_LTR_KEYBOARD_MOVEMENT","DEFAULT_RTL_KEYBOARD_MOVEMENT","findMatchIndex","getFirstFocusableIndex","getLastFocusableIndex","getNextFocusableIndex","getSearchText","getVirtualFocusDefaultIndex","isElementDisabled","isNotFocusable","isSearchableEvent","recalculateFocusIndex","context","config","current","loopable","searchable","horizontal","includeDisabled","tabIndexBehavior","undefined","activeDescendantId","displayName","Provider","KeyboardMovementProvider","useKeyboardMovementContext","noop","returnNegative1","useKeyboardMovementProvider","options","onClick","onFocus","onKeyDown","disabled","extendKeyDown","onFocusChange","programmatic","incrementKeys","propIncrementKeys","decrementKeys","propDecrementKeys","jumpToFirstKeys","propJumpToFirstKeys","jumpToLastKeys","propJumpToLastKeys","getDefaultFocusedIndex","isNegativeOneAllowed","isRTL","dir","defaults","configuration","setActiveDescendantId","movementContext","currentFocusIndex","mode","refocus","process","env","NODE_ENV","tabIndex","movementProps","event","currentTarget","target","HTMLElement","focusables","focusedIndex","findIndex","element","contains","length","focused","id","focus","index","isPropagationStopped","defaultFocusIndex","scrollIntoView","block","setFocusIndex","preventDefault","stopPropagation","inline","key","shiftKey","activeElement","click","value","values","map","startIndex","jumpToFirst","includes","jumpToLast","increment","decrement"],"mappings":"AAAA;AAEA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,QAAQ;AAEf,SAASC,wBAAwBC,2BAA2B,QAAQ,oBAAoB;AACxF,SAASC,sBAAsB,QAAQ,gDAAgD;AACvF,SAASC,MAAM,QAAQ,4CAA4C;AACnE,SAASC,yBAAyB,QAAQ,kCAAkC;AAC5E,SACEC,yBAAyB,EACzBC,6BAA6B,EAC7BC,6BAA6B,QACxB,iBAAiB;AACxB,SAASC,cAAc,QAAQ,sBAAsB;AAQrD,SACEC,sBAAsB,EACtBC,qBAAqB,EACrBC,qBAAqB,EACrBC,aAAa,EACbC,2BAA2B,EAC3BC,iBAAiB,EACjBC,cAAc,EACdC,iBAAiB,EACjBC,qBAAqB,QAChB,aAAa;AAEpB;;;CAGC,GACD,MAAMC,UAAUxB,cAAuC;IACrDyB,QAAQ;QAAEC,SAASf;IAA0B;IAC7CgB,UAAU;IACVC,YAAY;IACZC,YAAY;IACZC,iBAAiB;IACjBC,kBAAkBC;IAClBC,oBAAoB;AACtB;AACAT,QAAQU,WAAW,GAAG;AACtB,OAAO,MAAM,EAAEC,UAAUC,wBAAwB,EAAE,GAAGZ,QAAQ;AAE9D;;;CAGC,GACD,OAAO,SAASa;IACd,OAAOpC,WAAWuB;AACpB;AAEA,MAAMc,OAAO;AACX,aAAa;AACf;AAEA,MAAMC,kBAAkB,IAAc,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwHC,GACD,OAAO,SAASC,4BACdC,UAA8C,CAAC,CAAC;IAEhD,MAAM,EACJC,UAAUJ,IAAI,EACdK,UAAUL,IAAI,EACdM,YAAYN,IAAI,EAChBX,WAAW,KAAK,EAChBkB,QAAQ,EACRjB,aAAa,KAAK,EAClBC,aAAa,KAAK,EAClBC,kBAAkB,KAAK,EACvBC,gBAAgB,EAChBe,gBAAgBR,IAAI,EACpBS,gBAAgBT,IAAI,EACpBU,eAAelB,eAAe,EAC9BmB,eAAeC,iBAAiB,EAChCC,eAAeC,iBAAiB,EAChCC,iBAAiBC,mBAAmB,EACpCC,gBAAgBC,kBAAkB,EAClClD,uBAAuBC,2BAA2B,EAClDkD,yBAAyBlB,eAAe,EACxCmB,uBAAuB,KAAK,EAC7B,GAAGjB;IAEJ,MAAMkB,QAAQlD,SAASmD,GAAG,KAAK;IAC/B,IAAIC;IACJ,IAAIhC,YAAY;QACdgC,WAAWF,QACP9C,gCACAD;IACN,OAAO;QACLiD,WAAWlD;IACb;IAEA,MAAMsC,gBAAgBC,qBAAqBW,SAASZ,aAAa;IACjE,MAAME,gBAAgBC,qBAAqBS,SAASV,aAAa;IACjE,MAAME,kBAAkBC,uBAAuBO,SAASR,eAAe;IACvE,MAAME,iBAAiBC,sBAAsBK,SAASN,cAAc;IAEpE,MAAMO,gBAAwC;QAC5Cb;QACAE;QACAE;QACAE;IACF;IACA,MAAM9B,SAASrB,OAAO0D;IACtBpD,0BAA0B;QACxBe,OAAOC,OAAO,GAAGoC;IACnB;IAEA,MAAM,CAAC7B,oBAAoB8B,sBAAsB,GAAG1D,SAAS;IAC7D,MAAM2D,kBAAkB7D,QACtB,IAAO,CAAA;YACLsB;YACAE;YACAC;YACAC;YACAC;YACAC;YACAE;QACF,CAAA,GACA;QACEA;QACAJ;QACAC;QACAH;QACAC;QACAG;KACD;IAEH,MAAMkC,oBAAoB7D,OAAO,CAAC;IAClC,MAAM8D,OAAO1D;IACb,MAAM2D,UAAU/D,OAAO;IAEvB,IAAIgE,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,sEAAsE;QACtE,sDAAsD;QACtDpE,UAAU;YACR,OAAO;gBACL6D,sBAAsB;YACxB;QACF,GAAG,EAAE;IACP;IAEA,IAAIQ;IACJ,IAAIxC,kBAAkB;QACpBwC,WACE1B,YAAad,qBAAqB,YAAYE,qBAC1C,CAAC,IACD;IACR;IAEA,OAAO;QACLuC,eAAe;YACb,yBACEzC,qBAAqB,YAAYE,qBAAqBD;YACxDuC;YAEA,0EAA0E;YAC1E,+CAA+C;YAC/C7B,SAAQ+B,KAAK;gBACX/B,QAAQ+B;gBACR,IAAI5B,UAAU;oBACZ;gBACF;gBAEA,kEAAkE;gBAClE,yEAAyE;gBACzE,UAAU;gBACV,MAAM,EAAE6B,aAAa,EAAEC,MAAM,EAAE,GAAGF;gBAClC,IAAIE,WAAWD,iBAAiB,CAAEC,CAAAA,kBAAkBC,WAAU,GAAI;oBAChE;gBACF;gBAEA,MAAMC,aAAavE,qBAAqBoE,eAAe1B;gBACvD,MAAM8B,eAAeD,WAAWE,SAAS,CACvC,CAACC,UAAYA,YAAYL,UAAUK,QAAQC,QAAQ,CAACN;gBAEtD,IAAIG,iBAAiB,CAAC,KAAK,CAACD,WAAWK,MAAM,EAAE;oBAC7C;gBACF;gBAEAjB,kBAAkBvC,OAAO,GAAGoD;gBAC5B,MAAMK,UAAUN,UAAU,CAACC,aAAa;gBACxC,IAAI/C,kBAAkB;oBACpBgC,sBAAsBoB,QAAQC,EAAE;gBAClC;gBAEA,+DAA+D;gBAC/D,wBAAwB;gBACxB,IAAIrD,qBAAqB,WAAW;oBAClCoC,QAAQzC,OAAO,GAAG;oBAClBgD,cAAcW,KAAK;gBACrB;gBAEAtC,cAAc;oBACZuC,OAAOR;oBACPE,SAASG;gBACX;YACF;YACAxC,SAAQ8B,KAAK;gBACX9B,QAAQ8B;gBACR,IAAIA,MAAMc,oBAAoB,MAAMpB,QAAQzC,OAAO,EAAE;oBACnDyC,QAAQzC,OAAO,GAAG;oBAClB;gBACF;gBAEA,IACE,AAACwC,SAAS,cAAcnC,qBAAqB,aAC7C0C,MAAME,MAAM,KAAKF,MAAMC,aAAa,EACpC;oBACA;gBACF;gBAEA,MAAMG,aAAavE,qBACjBmE,MAAMC,aAAa,EACnB1B;gBAEF,IAAI,CAAC6B,WAAWK,MAAM,EAAE;oBACtB;gBACF;gBAEA,IAAIM,oBAAoB/B,uBAAuB;oBAC7CoB;oBACA/C;gBACF;gBAEA,oEAAoE;gBACpE,iEAAiE;gBACjE,kBAAkB;gBAClB,IAAI,CAAC4B,wBAAwB8B,sBAAsB,CAAC,GAAG;oBACrD,IAAIzD,qBAAqB,WAAW;wBAClC,yEAAyE;wBACzEyD,oBAAoBrE,4BAA4B;4BAC9C0D;4BACA/C;4BACAG;wBACF;oBACF,OAAO;wBACLuD,oBAAoBzE,uBAAuB;4BACzC8D;4BACA/C;wBACF;oBACF;gBACF;gBAEA,IAAI0D,sBAAsB,CAAC,GAAG;oBAC5B;gBACF;gBAEAvB,kBAAkBvC,OAAO,GAAG8D;gBAC5B,MAAML,UAAUN,UAAU,CAACW,kBAAkB;gBAC7C,IAAIzD,kBAAkB;oBACpBgC,sBAAsBoB,QAAQC,EAAE;gBAClC;gBAEA,IAAIrD,qBAAqB,WAAW;oBAClCoD,QAAQE,KAAK;gBACf,OAAO;oBACLF,QAAQM,cAAc,CAAC;wBAAEC,OAAO;oBAAU;gBAC5C;gBAEA3C,cAAc;oBACZuC,OAAOE;oBACPR,SAASG;gBACX;YACF;YACAvC,WAAU6B,KAAK;gBACb7B,UAAU6B;gBACV,IAAI5B,UAAU;oBACZ;gBACF;gBAEA,MAAM,EAAE6B,aAAa,EAAE,GAAGD;gBAE1B,MAAMkB,gBAAgB,CACpBL,OACAT;oBAEAJ,MAAMmB,cAAc;oBACpBnB,MAAMoB,eAAe;oBACrB,IAAI5B,kBAAkBvC,OAAO,KAAK4D,SAASA,UAAU,CAAC,GAAG;wBACvD;oBACF;oBAEArB,kBAAkBvC,OAAO,GAAG4D;oBAC5B,MAAMH,UAAUN,UAAU,CAACS,MAAM;oBACjC,IAAIvD,kBAAkB;wBACpBoD,QAAQM,cAAc,CAAC;4BACrBC,OAAO;4BACPI,QAAQ;wBACV;wBACA/B,sBAAsBoB,QAAQC,EAAE;oBAClC;oBAEA,IAAIrD,qBAAqB,WAAW;wBAClCoD,QAAQE,KAAK;oBACf;oBAEAtC,cAAc;wBACZuC;wBACAN,SAASG;oBACX;gBACF;gBAEArC,cAAc;oBACZ2B;oBACAkB;oBACA1B;oBACAF;oBACA,GAAGC,eAAe;gBACpB;gBAEA,IAAIS,MAAMc,oBAAoB,IAAI;oBAChC;gBACF;gBAEA,sEAAsE;gBACtE,wEAAwE;gBACxE,WAAW;gBACX,IAAI,CAAC7B,wBAAwBO,kBAAkBvC,OAAO,KAAK,CAAC,GAAG;oBAC7DuC,kBAAkBvC,OAAO,GAAGH,sBAAsB;wBAChDsD,YAAYvE,qBAAqBoE,eAAe1B;wBAChDlB;wBACAC;wBACAE;oBACF;gBACF;gBAEA,MAAM,EAAE8D,GAAG,EAAEC,QAAQ,EAAE,GAAGvB;gBAC1B,IACE1C,qBAAqB,aACrBE,sBACC8D,CAAAA,QAAQ,OAAOA,QAAQ,OAAM,GAC9B;oBACA,IAAIA,QAAQ,KAAK;wBACftB,MAAMmB,cAAc;oBACtB;oBAEA,MAAMf,aAAavE,qBAAqBoE,eAAe1B;oBACvD,MAAMiD,gBAAgBpB,UAAU,CAACZ,kBAAkBvC,OAAO,CAAC;oBAC3D,IAAI,CAACuE,iBAAiB7E,kBAAkB6E,gBAAgB;wBACtD;oBACF;oBAEAA,cAAcC,KAAK;oBACnB;gBACF;gBAEA,MAAM,EACJjD,aAAa,EACbE,aAAa,EACbE,eAAe,EACfE,cAAc,EACf,GAAG9B,OAAOC,OAAO;gBAElB,IAAIE,cAAcN,kBAAkBmD,QAAQ;oBAC1C,MAAMI,aAAavE,qBAAqBoE,eAAe1B;oBACvD,MAAMsC,QAAQxE,eAAe;wBAC3BqF,OAAOJ;wBACPK,QAAQvB,WAAWwB,GAAG,CAAC,CAACrB,UACtB9D,cAAc8D,SAAS,CAAC3D,eAAe2D,SAASlD;wBAElDwE,YAAYN,WAAW,CAAC,IAAI/B,kBAAkBvC,OAAO;oBACvD;oBACAiE,cAAcL,OAAOT;oBACrB;gBACF;gBAEA,MAAM0B,cAAclD,gBAAgBmD,QAAQ,CAACT;gBAC7C,MAAMU,aAAa,CAACF,eAAehD,eAAeiD,QAAQ,CAACT;gBAC3D,MAAMW,YACJ,CAACH,eAAe,CAACE,cAAcxD,cAAcuD,QAAQ,CAACT;gBACxD,MAAMY,YACJ,CAACJ,eACD,CAACE,cACD,CAACC,aACDvD,cAAcqD,QAAQ,CAACT;gBAEzB,IAAI,CAACQ,eAAe,CAACE,cAAc,CAACC,aAAa,CAACC,WAAW;oBAC3D;gBACF;gBACA,MAAM9B,aAAavE,qBAAqBoE,eAAe1B;gBAEvD,IAAIsC;gBACJ,IAAIiB,aAAa;oBACfjB,QAAQvE,uBAAuB;wBAC7B8D;wBACA/C;oBACF;gBACF,OAAO,IAAI2E,YAAY;oBACrBnB,QAAQtE,sBAAsB;wBAC5B6D;wBACA/C;oBACF;gBACF,OAAO;oBACLwD,QAAQrE,sBAAsB;wBAC5BU;wBACA+E;wBACA7B;wBACA/C;wBACAmC,mBAAmBA,kBAAkBvC,OAAO;oBAC9C;gBACF;gBAEAiE,cAAcL,OAAOT;YACvB;QACF;QACAb;QACAC;QACAhC;QACA8B;IACF;AACF"}

package/dist/movement/utils.d.ts

@@ -1,17 +1,17 @@
 import { type KeyboardEvent } from "react";
 import { type FocusableIndexOptions, type TabIndexBehavior } from "./types.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare const isElementDisabled: (element: HTMLElement) => boolean;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const isNotFocusable: (element: HTMLElement | undefined, includeDisabled: boolean) => boolean;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface VirtualFocusableIndexOptions {
@@ -20,22 +20,22 @@ export interface VirtualFocusableIndexOptions {
     activeDescendantId: string;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare const getVirtualFocusDefaultIndex: (options: VirtualFocusableIndexOptions) => number;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const getFirstFocusableIndex: (options: FocusableIndexOptions) => number;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const getLastFocusableIndex: (options: FocusableIndexOptions) => number;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 interface NextFocusableIndexOptions extends FocusableIndexOptions {
@@ -44,17 +44,17 @@ interface NextFocusableIndexOptions extends FocusableIndexOptions {
     currentFocusIndex: number;
 }
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const getNextFocusableIndex: (options: NextFocusableIndexOptions) => number;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare function getSearchText(element: HTMLElement, searchable: boolean): string;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface RecalculateOptions {
@@ -68,7 +68,7 @@ export interface RecalculateOptions {
  * between renders (i.e. expanding all tree items on the same level with `*`).
  * There might be a better way to handle this in the future.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function recalculateFocusIndex(options: RecalculateOptions): number;
@@ -82,12 +82,12 @@ export declare function recalculateFocusIndex(options: RecalculateOptions): numb
  * The shift key **is allowed** because holding shift means "search from the
  * beginning" instead of "search from current location".
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function isSearchableEvent(event: KeyboardEvent): boolean;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function isTypeEvent(event: KeyboardEvent): boolean;

package/dist/movement/utils.js

@@ -1,10 +1,10 @@
 import { loop } from "../utils/loop.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export const isElementDisabled = (element)=>element.getAttribute("disabled") !== null || element.getAttribute("aria-disabled") === "true";
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const isNotFocusable = (element, includeDisabled)=>{
     if (!element) {
@@ -16,7 +16,7 @@ import { loop } from "../utils/loop.js";
     return isElementDisabled(element);
 };
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export const getVirtualFocusDefaultIndex = (options)=>{
     const { focusables, includeDisabled, activeDescendantId } = options;
@@ -32,7 +32,7 @@ import { loop } from "../utils/loop.js";
     return Math.max(0, activeIndex);
 };
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const getFirstFocusableIndex = (options)=>{
     const { focusables, includeDisabled } = options;
@@ -49,7 +49,7 @@ import { loop } from "../utils/loop.js";
     return firstIndex;
 };
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const getLastFocusableIndex = (options)=>{
     const { focusables, includeDisabled } = options;
@@ -66,7 +66,7 @@ import { loop } from "../utils/loop.js";
     return lastIndex;
 };
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const getNextFocusableIndex = (options)=>{
     const { loopable, increment, focusables, includeDisabled, currentFocusIndex } = options;
@@ -102,7 +102,7 @@ import { loop } from "../utils/loop.js";
     return nextIndex;
 };
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export function getSearchText(element, searchable) {
     if (!searchable) {
@@ -124,7 +124,7 @@ import { loop } from "../utils/loop.js";
  * between renders (i.e. expanding all tree items on the same level with `*`).
  * There might be a better way to handle this in the future.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function recalculateFocusIndex(options) {
     const { focusables, includeDisabled, tabIndexBehavior, activeDescendantId } = options;
@@ -148,7 +148,7 @@ import { loop } from "../utils/loop.js";
  * The shift key **is allowed** because holding shift means "search from the
  * beginning" instead of "search from current location".
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function isSearchableEvent(event) {
     const { key, altKey, ctrlKey, metaKey } = event;
@@ -156,7 +156,7 @@ import { loop } from "../utils/loop.js";
     key !== " " && !altKey && !ctrlKey && !metaKey;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function isTypeEvent(event) {
     return isSearchableEvent(event) || [

package/dist/movement/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/movement/utils.ts"],"sourcesContent":["import { type KeyboardEvent } from \"react\";\nimport { loop } from \"../utils/loop.js\";\nimport { type FocusableIndexOptions, type TabIndexBehavior } from \"./types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const isElementDisabled = (element: HTMLElement): boolean =>\n  element.getAttribute(\"disabled\") !== null ||\n  element.getAttribute(\"aria-disabled\") === \"true\";\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const isNotFocusable = (\n  element: HTMLElement | undefined,\n  includeDisabled: boolean\n): boolean => {\n  if (!element) {\n    return true;\n  }\n\n  if (includeDisabled) {\n    return false;\n  }\n\n  return isElementDisabled(element);\n};\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface VirtualFocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  activeDescendantId: string;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport const getVirtualFocusDefaultIndex = (\n  options: VirtualFocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled, activeDescendantId } = options;\n  if (!focusables.length || (!activeDescendantId && includeDisabled)) {\n    return 0;\n  }\n\n  const activeIndex = focusables.findIndex((element) => {\n    if (activeDescendantId) {\n      return element.id === activeDescendantId;\n    }\n\n    return !isElementDisabled(element);\n  });\n  return Math.max(0, activeIndex);\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getFirstFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let firstIndex = 0;\n  while (\n    firstIndex < focusables.length - 1 &&\n    isNotFocusable(focusables[firstIndex], includeDisabled)\n  ) {\n    firstIndex += 1;\n  }\n\n  if (isNotFocusable(focusables[firstIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return firstIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getLastFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let lastIndex = focusables.length - 1;\n  while (\n    lastIndex > 0 &&\n    isNotFocusable(focusables[lastIndex], includeDisabled)\n  ) {\n    lastIndex -= 1;\n  }\n\n  if (isNotFocusable(focusables[lastIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return lastIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\ninterface NextFocusableIndexOptions extends FocusableIndexOptions {\n  loopable: boolean;\n  increment: boolean;\n  currentFocusIndex: number;\n}\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getNextFocusableIndex = (\n  options: NextFocusableIndexOptions\n): number => {\n  const {\n    loopable,\n    increment,\n    focusables,\n    includeDisabled,\n    currentFocusIndex,\n  } = options;\n  if (!focusables.length) {\n    return currentFocusIndex;\n  }\n\n  const min = getFirstFocusableIndex({ focusables, includeDisabled });\n  const max = getLastFocusableIndex({ focusables, includeDisabled });\n  let nextIndex = loop({\n    min,\n    max,\n    value: currentFocusIndex,\n    minmax: !loopable,\n    increment,\n  });\n  while (\n    isNotFocusable(focusables[nextIndex], includeDisabled) &&\n    (loopable || nextIndex !== (increment ? max : min))\n  ) {\n    nextIndex = loop({\n      min,\n      max,\n      value: nextIndex,\n      minmax: !loopable,\n      increment,\n    });\n  }\n\n  // Since the `min` and `max` values are \"safely\" set, I don't need to verify\n  // the nextIndex is still focusable\n  return nextIndex;\n};\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport function getSearchText(\n  element: HTMLElement,\n  searchable: boolean\n): string {\n  if (!searchable) {\n    return \"\";\n  }\n\n  const cloned = element.cloneNode(true) as HTMLElement;\n  cloned\n    .querySelectorAll(\n      // Note: do not include DISPLAY_NONE_CLASS since it is presentational only\n      \".rmd-icon--font,[aria-hidden=true],[hidden],[role=presentation]\"\n    )\n    .forEach((element) => {\n      element.parentNode?.removeChild(element);\n    });\n\n  // Note: It would be good to use `cloned.innerText` (maybe?) at some point,\n  // but it returns `undefined` in jsdom. It also does cause a reflow, so maybe\n  // this is fine?\n  // https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext\n  return (cloned.textContent || \"\")[0].toUpperCase();\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RecalculateOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  tabIndexBehavior: TabIndexBehavior | undefined;\n  activeDescendantId: string;\n}\n\n/**\n * This was added to help with specific widgets that cause focus index to change\n * between renders (i.e. expanding all tree items on the same level with `*`).\n * There might be a better way to handle this in the future.\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function recalculateFocusIndex(options: RecalculateOptions): number {\n  const { focusables, includeDisabled, tabIndexBehavior, activeDescendantId } =\n    options;\n  if (tabIndexBehavior === \"virtual\") {\n    return getVirtualFocusDefaultIndex({\n      focusables,\n      includeDisabled,\n      activeDescendantId,\n    });\n  }\n\n  const { activeElement } = document;\n  return focusables.findIndex((element) => element === activeElement);\n}\n\n/**\n * Checks if a keyboard event can trigger a search through focusable elements\n * by:\n *\n * - checking if the key is a single letter that is not the space key\n * - checking that the alt, ctrl, and meta keys are not being held\n *\n * The shift key **is allowed** because holding shift means \"search from the\n * beginning\" instead of \"search from current location\".\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function isSearchableEvent(event: KeyboardEvent): boolean {\n  const { key, altKey, ctrlKey, metaKey } = event;\n\n  return (\n    key.length === 1 &&\n    // can't search with space since it is generally a click event\n    key !== \" \" &&\n    !altKey &&\n    !ctrlKey &&\n    !metaKey\n  );\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function isTypeEvent(event: KeyboardEvent): boolean {\n  return (\n    isSearchableEvent(event) || [\"Backspace\", \"Delete\", \" \"].includes(event.key)\n  );\n}\n"],"names":["loop","isElementDisabled","element","getAttribute","isNotFocusable","includeDisabled","getVirtualFocusDefaultIndex","options","focusables","activeDescendantId","length","activeIndex","findIndex","id","Math","max","getFirstFocusableIndex","firstIndex","getLastFocusableIndex","lastIndex","getNextFocusableIndex","loopable","increment","currentFocusIndex","min","nextIndex","value","minmax","getSearchText","searchable","cloned","cloneNode","querySelectorAll","forEach","parentNode","removeChild","textContent","toUpperCase","recalculateFocusIndex","tabIndexBehavior","activeElement","document","isSearchableEvent","event","key","altKey","ctrlKey","metaKey","isTypeEvent","includes"],"mappings":"AACA,SAASA,IAAI,QAAQ,mBAAmB;AAGxC;;;CAGC,GACD,OAAO,MAAMC,oBAAoB,CAACC,UAChCA,QAAQC,YAAY,CAAC,gBAAgB,QACrCD,QAAQC,YAAY,CAAC,qBAAqB,OAAO;AAEnD;;;CAGC,GACD,OAAO,MAAMC,iBAAiB,CAC5BF,SACAG;IAEA,IAAI,CAACH,SAAS;QACZ,OAAO;IACT;IAEA,IAAIG,iBAAiB;QACnB,OAAO;IACT;IAEA,OAAOJ,kBAAkBC;AAC3B,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMI,8BAA8B,CACzCC;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEI,kBAAkB,EAAE,GAAGF;IAC5D,IAAI,CAACC,WAAWE,MAAM,IAAK,CAACD,sBAAsBJ,iBAAkB;QAClE,OAAO;IACT;IAEA,MAAMM,cAAcH,WAAWI,SAAS,CAAC,CAACV;QACxC,IAAIO,oBAAoB;YACtB,OAAOP,QAAQW,EAAE,KAAKJ;QACxB;QAEA,OAAO,CAACR,kBAAkBC;IAC5B;IACA,OAAOY,KAAKC,GAAG,CAAC,GAAGJ;AACrB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMK,yBAAyB,CACpCT;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIO,aAAa;IACjB,MACEA,aAAaT,WAAWE,MAAM,GAAG,KACjCN,eAAeI,UAAU,CAACS,WAAW,EAAEZ,iBACvC;QACAY,cAAc;IAChB;IAEA,IAAIb,eAAeI,UAAU,CAACS,WAAW,EAAEZ,kBAAkB;QAC3D,OAAO,CAAC;IACV;IAEA,OAAOY;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCX;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIS,YAAYX,WAAWE,MAAM,GAAG;IACpC,MACES,YAAY,KACZf,eAAeI,UAAU,CAACW,UAAU,EAAEd,iBACtC;QACAc,aAAa;IACf;IAEA,IAAIf,eAAeI,UAAU,CAACW,UAAU,EAAEd,kBAAkB;QAC1D,OAAO,CAAC;IACV;IAEA,OAAOc;AACT,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCb;IAEA,MAAM,EACJc,QAAQ,EACRC,SAAS,EACTd,UAAU,EACVH,eAAe,EACfkB,iBAAiB,EAClB,GAAGhB;IACJ,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAOa;IACT;IAEA,MAAMC,MAAMR,uBAAuB;QAAER;QAAYH;IAAgB;IACjE,MAAMU,MAAMG,sBAAsB;QAAEV;QAAYH;IAAgB;IAChE,IAAIoB,YAAYzB,KAAK;QACnBwB;QACAT;QACAW,OAAOH;QACPI,QAAQ,CAACN;QACTC;IACF;IACA,MACElB,eAAeI,UAAU,CAACiB,UAAU,EAAEpB,oBACrCgB,CAAAA,YAAYI,cAAeH,CAAAA,YAAYP,MAAMS,GAAE,CAAC,EACjD;QACAC,YAAYzB,KAAK;YACfwB;YACAT;YACAW,OAAOD;YACPE,QAAQ,CAACN;YACTC;QACF;IACF;IAEA,4EAA4E;IAC5E,mCAAmC;IACnC,OAAOG;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASG,cACd1B,OAAoB,EACpB2B,UAAmB;IAEnB,IAAI,CAACA,YAAY;QACf,OAAO;IACT;IAEA,MAAMC,SAAS5B,QAAQ6B,SAAS,CAAC;IACjCD,OACGE,gBAAgB,CACf,0EAA0E;IAC1E,mEAEDC,OAAO,CAAC,CAAC/B;QACRA,QAAQgC,UAAU,EAAEC,YAAYjC;IAClC;IAEF,2EAA2E;IAC3E,6EAA6E;IAC7E,gBAAgB;IAChB,+FAA+F;IAC/F,OAAO,AAAC4B,CAAAA,OAAOM,WAAW,IAAI,EAAC,CAAE,CAAC,EAAE,CAACC,WAAW;AAClD;AAaA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsB/B,OAA2B;IAC/D,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEkC,gBAAgB,EAAE9B,kBAAkB,EAAE,GACzEF;IACF,IAAIgC,qBAAqB,WAAW;QAClC,OAAOjC,4BAA4B;YACjCE;YACAH;YACAI;QACF;IACF;IAEA,MAAM,EAAE+B,aAAa,EAAE,GAAGC;IAC1B,OAAOjC,WAAWI,SAAS,CAAC,CAACV,UAAYA,YAAYsC;AACvD;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASE,kBAAkBC,KAAoB;IACpD,MAAM,EAAEC,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAE,GAAGJ;IAE1C,OACEC,IAAIlC,MAAM,KAAK,KACf,8DAA8D;IAC9DkC,QAAQ,OACR,CAACC,UACD,CAACC,WACD,CAACC;AAEL;AAEA;;;CAGC,GACD,OAAO,SAASC,YAAYL,KAAoB;IAC9C,OACED,kBAAkBC,UAAU;QAAC;QAAa;QAAU;KAAI,CAACM,QAAQ,CAACN,MAAMC,GAAG;AAE/E"}
+{"version":3,"sources":["../../src/movement/utils.ts"],"sourcesContent":["import { type KeyboardEvent } from \"react\";\n\nimport { loop } from \"../utils/loop.js\";\nimport { type FocusableIndexOptions, type TabIndexBehavior } from \"./types.js\";\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport const isElementDisabled = (element: HTMLElement): boolean =>\n  element.getAttribute(\"disabled\") !== null ||\n  element.getAttribute(\"aria-disabled\") === \"true\";\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport const isNotFocusable = (\n  element: HTMLElement | undefined,\n  includeDisabled: boolean\n): boolean => {\n  if (!element) {\n    return true;\n  }\n\n  if (includeDisabled) {\n    return false;\n  }\n\n  return isElementDisabled(element);\n};\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface VirtualFocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  activeDescendantId: string;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport const getVirtualFocusDefaultIndex = (\n  options: VirtualFocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled, activeDescendantId } = options;\n  if (!focusables.length || (!activeDescendantId && includeDisabled)) {\n    return 0;\n  }\n\n  const activeIndex = focusables.findIndex((element) => {\n    if (activeDescendantId) {\n      return element.id === activeDescendantId;\n    }\n\n    return !isElementDisabled(element);\n  });\n  return Math.max(0, activeIndex);\n};\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport const getFirstFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let firstIndex = 0;\n  while (\n    firstIndex < focusables.length - 1 &&\n    isNotFocusable(focusables[firstIndex], includeDisabled)\n  ) {\n    firstIndex += 1;\n  }\n\n  if (isNotFocusable(focusables[firstIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return firstIndex;\n};\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport const getLastFocusableIndex = (\n  options: FocusableIndexOptions\n): number => {\n  const { focusables, includeDisabled } = options;\n\n  if (!focusables.length) {\n    return -1;\n  }\n\n  let lastIndex = focusables.length - 1;\n  while (\n    lastIndex > 0 &&\n    isNotFocusable(focusables[lastIndex], includeDisabled)\n  ) {\n    lastIndex -= 1;\n  }\n\n  if (isNotFocusable(focusables[lastIndex], includeDisabled)) {\n    return -1;\n  }\n\n  return lastIndex;\n};\n\n/**\n * @since 5.0.0\n * @internal\n */\ninterface NextFocusableIndexOptions extends FocusableIndexOptions {\n  loopable: boolean;\n  increment: boolean;\n  currentFocusIndex: number;\n}\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport const getNextFocusableIndex = (\n  options: NextFocusableIndexOptions\n): number => {\n  const {\n    loopable,\n    increment,\n    focusables,\n    includeDisabled,\n    currentFocusIndex,\n  } = options;\n  if (!focusables.length) {\n    return currentFocusIndex;\n  }\n\n  const min = getFirstFocusableIndex({ focusables, includeDisabled });\n  const max = getLastFocusableIndex({ focusables, includeDisabled });\n  let nextIndex = loop({\n    min,\n    max,\n    value: currentFocusIndex,\n    minmax: !loopable,\n    increment,\n  });\n  while (\n    isNotFocusable(focusables[nextIndex], includeDisabled) &&\n    (loopable || nextIndex !== (increment ? max : min))\n  ) {\n    nextIndex = loop({\n      min,\n      max,\n      value: nextIndex,\n      minmax: !loopable,\n      increment,\n    });\n  }\n\n  // Since the `min` and `max` values are \"safely\" set, I don't need to verify\n  // the nextIndex is still focusable\n  return nextIndex;\n};\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport function getSearchText(\n  element: HTMLElement,\n  searchable: boolean\n): string {\n  if (!searchable) {\n    return \"\";\n  }\n\n  const cloned = element.cloneNode(true) as HTMLElement;\n  cloned\n    .querySelectorAll(\n      // Note: do not include DISPLAY_NONE_CLASS since it is presentational only\n      \".rmd-icon--font,[aria-hidden=true],[hidden],[role=presentation]\"\n    )\n    .forEach((element) => {\n      element.parentNode?.removeChild(element);\n    });\n\n  // Note: It would be good to use `cloned.innerText` (maybe?) at some point,\n  // but it returns `undefined` in jsdom. It also does cause a reflow, so maybe\n  // this is fine?\n  // https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext\n  return (cloned.textContent || \"\")[0].toUpperCase();\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface RecalculateOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n  tabIndexBehavior: TabIndexBehavior | undefined;\n  activeDescendantId: string;\n}\n\n/**\n * This was added to help with specific widgets that cause focus index to change\n * between renders (i.e. expanding all tree items on the same level with `*`).\n * There might be a better way to handle this in the future.\n *\n * @since 6.0.0\n * @internal\n */\nexport function recalculateFocusIndex(options: RecalculateOptions): number {\n  const { focusables, includeDisabled, tabIndexBehavior, activeDescendantId } =\n    options;\n  if (tabIndexBehavior === \"virtual\") {\n    return getVirtualFocusDefaultIndex({\n      focusables,\n      includeDisabled,\n      activeDescendantId,\n    });\n  }\n\n  const { activeElement } = document;\n  return focusables.findIndex((element) => element === activeElement);\n}\n\n/**\n * Checks if a keyboard event can trigger a search through focusable elements\n * by:\n *\n * - checking if the key is a single letter that is not the space key\n * - checking that the alt, ctrl, and meta keys are not being held\n *\n * The shift key **is allowed** because holding shift means \"search from the\n * beginning\" instead of \"search from current location\".\n *\n * @since 6.0.0\n * @internal\n */\nexport function isSearchableEvent(event: KeyboardEvent): boolean {\n  const { key, altKey, ctrlKey, metaKey } = event;\n\n  return (\n    key.length === 1 &&\n    // can't search with space since it is generally a click event\n    key !== \" \" &&\n    !altKey &&\n    !ctrlKey &&\n    !metaKey\n  );\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport function isTypeEvent(event: KeyboardEvent): boolean {\n  return (\n    isSearchableEvent(event) || [\"Backspace\", \"Delete\", \" \"].includes(event.key)\n  );\n}\n"],"names":["loop","isElementDisabled","element","getAttribute","isNotFocusable","includeDisabled","getVirtualFocusDefaultIndex","options","focusables","activeDescendantId","length","activeIndex","findIndex","id","Math","max","getFirstFocusableIndex","firstIndex","getLastFocusableIndex","lastIndex","getNextFocusableIndex","loopable","increment","currentFocusIndex","min","nextIndex","value","minmax","getSearchText","searchable","cloned","cloneNode","querySelectorAll","forEach","parentNode","removeChild","textContent","toUpperCase","recalculateFocusIndex","tabIndexBehavior","activeElement","document","isSearchableEvent","event","key","altKey","ctrlKey","metaKey","isTypeEvent","includes"],"mappings":"AAEA,SAASA,IAAI,QAAQ,mBAAmB;AAGxC;;;CAGC,GACD,OAAO,MAAMC,oBAAoB,CAACC,UAChCA,QAAQC,YAAY,CAAC,gBAAgB,QACrCD,QAAQC,YAAY,CAAC,qBAAqB,OAAO;AAEnD;;;CAGC,GACD,OAAO,MAAMC,iBAAiB,CAC5BF,SACAG;IAEA,IAAI,CAACH,SAAS;QACZ,OAAO;IACT;IAEA,IAAIG,iBAAiB;QACnB,OAAO;IACT;IAEA,OAAOJ,kBAAkBC;AAC3B,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMI,8BAA8B,CACzCC;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEI,kBAAkB,EAAE,GAAGF;IAC5D,IAAI,CAACC,WAAWE,MAAM,IAAK,CAACD,sBAAsBJ,iBAAkB;QAClE,OAAO;IACT;IAEA,MAAMM,cAAcH,WAAWI,SAAS,CAAC,CAACV;QACxC,IAAIO,oBAAoB;YACtB,OAAOP,QAAQW,EAAE,KAAKJ;QACxB;QAEA,OAAO,CAACR,kBAAkBC;IAC5B;IACA,OAAOY,KAAKC,GAAG,CAAC,GAAGJ;AACrB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMK,yBAAyB,CACpCT;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIO,aAAa;IACjB,MACEA,aAAaT,WAAWE,MAAM,GAAG,KACjCN,eAAeI,UAAU,CAACS,WAAW,EAAEZ,iBACvC;QACAY,cAAc;IAChB;IAEA,IAAIb,eAAeI,UAAU,CAACS,WAAW,EAAEZ,kBAAkB;QAC3D,OAAO,CAAC;IACV;IAEA,OAAOY;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCX;IAEA,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAE,GAAGE;IAExC,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAO,CAAC;IACV;IAEA,IAAIS,YAAYX,WAAWE,MAAM,GAAG;IACpC,MACES,YAAY,KACZf,eAAeI,UAAU,CAACW,UAAU,EAAEd,iBACtC;QACAc,aAAa;IACf;IAEA,IAAIf,eAAeI,UAAU,CAACW,UAAU,EAAEd,kBAAkB;QAC1D,OAAO,CAAC;IACV;IAEA,OAAOc;AACT,EAAE;AAYF;;;CAGC,GACD,OAAO,MAAMC,wBAAwB,CACnCb;IAEA,MAAM,EACJc,QAAQ,EACRC,SAAS,EACTd,UAAU,EACVH,eAAe,EACfkB,iBAAiB,EAClB,GAAGhB;IACJ,IAAI,CAACC,WAAWE,MAAM,EAAE;QACtB,OAAOa;IACT;IAEA,MAAMC,MAAMR,uBAAuB;QAAER;QAAYH;IAAgB;IACjE,MAAMU,MAAMG,sBAAsB;QAAEV;QAAYH;IAAgB;IAChE,IAAIoB,YAAYzB,KAAK;QACnBwB;QACAT;QACAW,OAAOH;QACPI,QAAQ,CAACN;QACTC;IACF;IACA,MACElB,eAAeI,UAAU,CAACiB,UAAU,EAAEpB,oBACrCgB,CAAAA,YAAYI,cAAeH,CAAAA,YAAYP,MAAMS,GAAE,CAAC,EACjD;QACAC,YAAYzB,KAAK;YACfwB;YACAT;YACAW,OAAOD;YACPE,QAAQ,CAACN;YACTC;QACF;IACF;IAEA,4EAA4E;IAC5E,mCAAmC;IACnC,OAAOG;AACT,EAAE;AAEF;;;CAGC,GACD,OAAO,SAASG,cACd1B,OAAoB,EACpB2B,UAAmB;IAEnB,IAAI,CAACA,YAAY;QACf,OAAO;IACT;IAEA,MAAMC,SAAS5B,QAAQ6B,SAAS,CAAC;IACjCD,OACGE,gBAAgB,CACf,0EAA0E;IAC1E,mEAEDC,OAAO,CAAC,CAAC/B;QACRA,QAAQgC,UAAU,EAAEC,YAAYjC;IAClC;IAEF,2EAA2E;IAC3E,6EAA6E;IAC7E,gBAAgB;IAChB,+FAA+F;IAC/F,OAAO,AAAC4B,CAAAA,OAAOM,WAAW,IAAI,EAAC,CAAE,CAAC,EAAE,CAACC,WAAW;AAClD;AAaA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsB/B,OAA2B;IAC/D,MAAM,EAAEC,UAAU,EAAEH,eAAe,EAAEkC,gBAAgB,EAAE9B,kBAAkB,EAAE,GACzEF;IACF,IAAIgC,qBAAqB,WAAW;QAClC,OAAOjC,4BAA4B;YACjCE;YACAH;YACAI;QACF;IACF;IAEA,MAAM,EAAE+B,aAAa,EAAE,GAAGC;IAC1B,OAAOjC,WAAWI,SAAS,CAAC,CAACV,UAAYA,YAAYsC;AACvD;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASE,kBAAkBC,KAAoB;IACpD,MAAM,EAAEC,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAE,GAAGJ;IAE1C,OACEC,IAAIlC,MAAM,KAAK,KACf,8DAA8D;IAC9DkC,QAAQ,OACR,CAACC,UACD,CAACC,WACD,CAACC;AAEL;AAEA;;;CAGC,GACD,OAAO,SAASC,YAAYL,KAAoB;IAC9C,OACED,kBAAkBC,UAAU;QAAC;QAAa;QAAU;KAAI,CAACM,QAAQ,CAACN,MAAMC,GAAG;AAE/E"}

package/dist/navigation/CollapsibleNavGroup.d.ts

@@ -0,0 +1,32 @@
+import { type LiHTMLAttributes, type ReactNode } from "react";
+import { type ButtonProps } from "../button/Button.js";
+import { type CollapseTransitionHookOptions } from "../transition/useCollapseTransition.js";
+import { type PropsWithRef } from "../types.js";
+import { type NavGroupProps } from "./NavGroup.js";
+import { type NavItemButtonRotatorProps } from "./NavItemButton.js";
+/**
+ * @since 6.0.0
+ */
+export interface CollapsibleNavGroupProps extends NavGroupProps, NavItemButtonRotatorProps {
+    liProps?: PropsWithRef<LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>;
+    buttonProps?: PropsWithRef<ButtonProps, HTMLButtonElement>;
+    collapseOptions?: Omit<CollapseTransitionHookOptions<HTMLUListElement>, "nodeRef" | "className" | "transitionIn">;
+    /**
+     * The children to render in the {@link NavItemButton} that toggles the
+     * collapsed state
+     */
+    buttonChildren: ReactNode;
+    /**
+     * The content that should be rendered in the non-collapsed {@link NavGroup}.
+     */
+    children: ReactNode;
+    collapsed: boolean;
+    toggleCollapsed: () => void;
+}
+/**
+ * **Client Component**
+ *
+ * @see {@link https://next.react-md.dev/components/navigation | Navigation Demos}
+ * @since 6.0.0
+ */
+export declare const CollapsibleNavGroup: import("react").ForwardRefExoticComponent<CollapsibleNavGroupProps & import("react").RefAttributes<HTMLUListElement>>;

package/dist/navigation/CollapsibleNavGroup.js

@@ -0,0 +1,49 @@
+"use client";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { forwardRef } from "react";
+import { useCollapseTransition } from "../transition/useCollapseTransition.js";
+import { NavGroup } from "./NavGroup.js";
+import { NavItem } from "./NavItem.js";
+import { NavItemButton } from "./NavItemButton.js";
+const noop = ()=>{
+// do nothing
+};
+/**
+ * **Client Component**
+ *
+ * @see {@link https://next.react-md.dev/components/navigation | Navigation Demos}
+ * @since 6.0.0
+ */ export const CollapsibleNavGroup = /*#__PURE__*/ forwardRef(function CollapsibleNavGroup(props, ref) {
+    const { liProps, buttonProps, buttonChildren, icon, iconRotatorProps, disableIconRotator, className, children, collapsed, toggleCollapsed, collapseOptions, ...remaining } = props;
+    const { rendered, elementProps } = useCollapseTransition({
+        ...collapseOptions,
+        nodeRef: ref,
+        className,
+        transitionIn: !collapsed
+    });
+    const onButtonClick = buttonProps?.onClick ?? noop;
+    return /*#__PURE__*/ _jsxs(NavItem, {
+        ...liProps,
+        children: [
+            /*#__PURE__*/ _jsx(NavItemButton, {
+                ...buttonProps,
+                onClick: (event)=>{
+                    onButtonClick(event);
+                    toggleCollapsed();
+                },
+                collapsed: collapsed,
+                icon: icon,
+                iconRotatorProps: iconRotatorProps,
+                disableIconRotator: disableIconRotator,
+                children: buttonChildren
+            }),
+            rendered && /*#__PURE__*/ _jsx(NavGroup, {
+                ...remaining,
+                ...elementProps,
+                children: children
+            })
+        ]
+    });
+});
+
+//# sourceMappingURL=CollapsibleNavGroup.js.map

package/dist/navigation/CollapsibleNavGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/navigation/CollapsibleNavGroup.tsx"],"sourcesContent":["\"use client\";\n\nimport { type LiHTMLAttributes, type ReactNode, forwardRef } from \"react\";\n\nimport { type ButtonProps } from \"../button/Button.js\";\nimport {\n  type CollapseTransitionHookOptions,\n  useCollapseTransition,\n} from \"../transition/useCollapseTransition.js\";\nimport { type PropsWithRef } from \"../types.js\";\nimport { NavGroup, type NavGroupProps } from \"./NavGroup.js\";\nimport { NavItem } from \"./NavItem.js\";\nimport {\n  NavItemButton,\n  type NavItemButtonRotatorProps,\n} from \"./NavItemButton.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * @since 6.0.0\n */\nexport interface CollapsibleNavGroupProps\n  extends NavGroupProps,\n    NavItemButtonRotatorProps {\n  liProps?: PropsWithRef<LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>;\n  buttonProps?: PropsWithRef<ButtonProps, HTMLButtonElement>;\n  collapseOptions?: Omit<\n    CollapseTransitionHookOptions<HTMLUListElement>,\n    \"nodeRef\" | \"className\" | \"transitionIn\"\n  >;\n\n  /**\n   * The children to render in the {@link NavItemButton} that toggles the\n   * collapsed state\n   */\n  buttonChildren: ReactNode;\n\n  /**\n   * The content that should be rendered in the non-collapsed {@link NavGroup}.\n   */\n  children: ReactNode;\n\n  collapsed: boolean;\n  toggleCollapsed: () => void;\n}\n\n/**\n * **Client Component**\n *\n * @see {@link https://next.react-md.dev/components/navigation | Navigation Demos}\n * @since 6.0.0\n */\nexport const CollapsibleNavGroup = forwardRef<\n  HTMLUListElement,\n  CollapsibleNavGroupProps\n>(function CollapsibleNavGroup(props, ref) {\n  const {\n    liProps,\n    buttonProps,\n    buttonChildren,\n    icon,\n    iconRotatorProps,\n    disableIconRotator,\n    className,\n    children,\n    collapsed,\n    toggleCollapsed,\n    collapseOptions,\n    ...remaining\n  } = props;\n\n  const { rendered, elementProps } = useCollapseTransition({\n    ...collapseOptions,\n    nodeRef: ref,\n    className,\n    transitionIn: !collapsed,\n  });\n  const onButtonClick = buttonProps?.onClick ?? noop;\n\n  return (\n    <NavItem {...liProps}>\n      <NavItemButton\n        {...buttonProps}\n        onClick={(event) => {\n          onButtonClick(event);\n          toggleCollapsed();\n        }}\n        collapsed={collapsed}\n        icon={icon}\n        iconRotatorProps={iconRotatorProps}\n        disableIconRotator={disableIconRotator}\n      >\n        {buttonChildren}\n      </NavItemButton>\n      {rendered && (\n        <NavGroup {...remaining} {...elementProps}>\n          {children}\n        </NavGroup>\n      )}\n    </NavItem>\n  );\n});\n"],"names":["forwardRef","useCollapseTransition","NavGroup","NavItem","NavItemButton","noop","CollapsibleNavGroup","props","ref","liProps","buttonProps","buttonChildren","icon","iconRotatorProps","disableIconRotator","className","children","collapsed","toggleCollapsed","collapseOptions","remaining","rendered","elementProps","nodeRef","transitionIn","onButtonClick","onClick","event"],"mappings":"AAAA;;AAEA,SAAgDA,UAAU,QAAQ,QAAQ;AAG1E,SAEEC,qBAAqB,QAChB,yCAAyC;AAEhD,SAASC,QAAQ,QAA4B,gBAAgB;AAC7D,SAASC,OAAO,QAAQ,eAAe;AACvC,SACEC,aAAa,QAER,qBAAqB;AAE5B,MAAMC,OAAO;AACX,aAAa;AACf;AA8BA;;;;;CAKC,GACD,OAAO,MAAMC,oCAAsBN,WAGjC,SAASM,oBAAoBC,KAAK,EAAEC,GAAG;IACvC,MAAM,EACJC,OAAO,EACPC,WAAW,EACXC,cAAc,EACdC,IAAI,EACJC,gBAAgB,EAChBC,kBAAkB,EAClBC,SAAS,EACTC,QAAQ,EACRC,SAAS,EACTC,eAAe,EACfC,eAAe,EACf,GAAGC,WACJ,GAAGb;IAEJ,MAAM,EAAEc,QAAQ,EAAEC,YAAY,EAAE,GAAGrB,sBAAsB;QACvD,GAAGkB,eAAe;QAClBI,SAASf;QACTO;QACAS,cAAc,CAACP;IACjB;IACA,MAAMQ,gBAAgBf,aAAagB,WAAWrB;IAE9C,qBACE,MAACF;QAAS,GAAGM,OAAO;;0BAClB,KAACL;gBACE,GAAGM,WAAW;gBACfgB,SAAS,CAACC;oBACRF,cAAcE;oBACdT;gBACF;gBACAD,WAAWA;gBACXL,MAAMA;gBACNC,kBAAkBA;gBAClBC,oBAAoBA;0BAEnBH;;YAEFU,0BACC,KAACnB;gBAAU,GAAGkB,SAAS;gBAAG,GAAGE,YAAY;0BACtCN;;;;AAKX,GAAG"}

package/dist/navigation/DefaultNavigationRenderer.d.ts

@@ -0,0 +1,22 @@
+import { type ReactElement } from "react";
+import { type RenderRecursiveItemsProps } from "../utils/RenderRecursively.js";
+import { type NavigationItem, type NavigationRenderData } from "./types.js";
+/**
+ * @since 6.0.0
+ */
+export type DefaultNavigationRendererProps<Item extends NavigationItem = NavigationItem, Data extends NavigationRenderData = NavigationRenderData> = RenderRecursiveItemsProps<Item, Data>;
+/**
+ * **Client Component**
+ *
+ * The default behavior is attempt to render in order:
+ * - `const { type, items, ...props } = item`
+ * - `type === "divider"` - `<Divider {...props} />`
+ * - `type === "subheader"` - `<NavSubheader {...props} />`
+ * - `type === "group"` - `<><NavSubheader {...props} />{children}</>`
+ * - `!!items` - `<CollapsibleNavGroup />`
+ * - `<NavItemLink {...item} as={linkComponent} active={pathname === href} />`
+ *
+ * @see {@link https://next.react-md.dev/components/navigation | Navigation Demos}
+ * @since 6.0.0
+ */
+export declare function DefaultNavigationRenderer<Item extends NavigationItem, Data extends NavigationRenderData>(props: DefaultNavigationRendererProps<Item, Data>): ReactElement;