@react-md/core 1.0.0-next.12 → 1.0.0-next.13

package/dist/menu/MenuWidget.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/menu/MenuWidget.tsx"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport { forwardRef, useRef, useState, type HTMLAttributes } from \"react\";\nimport { List } from \"../list/List.js\";\nimport { type GetDefaultFocusedIndex } from \"../movement/types.js\";\nimport { useKeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\nimport { type NonNullMutableRef } from \"../types.js\";\nimport { bem } from \"../utils/bem.js\";\nimport { type MenuListConvenienceProps } from \"./Menu.js\";\nimport { MenuWidgetKeyboardProvider } from \"./MenuWidgetKeyboardProvider.js\";\nimport {\n  MenuBarProvider,\n  useMenuBarContext,\n  useMenuBarProvider,\n} from \"./useMenuBarProvider.js\";\n\nconst styles = bem(\"rmd-menu\");\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface MenuClassNameOptions {\n  className?: string;\n  horizontal?: boolean;\n  elevated?: boolean;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function menu(options: MenuClassNameOptions = {}): string {\n  const { className, horizontal, elevated } = options;\n\n  return cnb(styles({ horizontal, elevated }), className);\n}\n\n/**\n * @internal\n */\nexport interface MenuWidgetProps\n  extends HTMLAttributes<HTMLDivElement>,\n    MenuListConvenienceProps {\n  isSheet: boolean;\n  horizontal: boolean;\n  disableElevation?: boolean;\n  cancelUnmountFocus: NonNullMutableRef<boolean>;\n  getDefaultFocusedIndex?: GetDefaultFocusedIndex;\n}\n\n/**\n * **Client Component**\n *\n * This component was added to support the listbox role and the `useId()` hook.\n * If the `temporary` prop is set, the `MenuItem`'s ids will not be the same the\n * next time the menu opens, so the aria-activedescendant will point to a\n * non-existing id\n *\n * @internal\n */\nexport const MenuWidget = forwardRef<HTMLDivElement, MenuWidgetProps>(\n  function MenuWidget(props, ref) {\n    const {\n      id,\n      role = \"menu\",\n      className,\n      listStyle,\n      listClassName,\n      listProps,\n      children,\n      onClick,\n      onBlur = noop,\n      onFocus = noop,\n      onKeyDown = noop,\n      tabIndex = -1,\n      isSheet,\n      horizontal,\n      disableElevation,\n      cancelUnmountFocus,\n      getDefaultFocusedIndex,\n      ...remaining\n    } = props;\n    const isListbox = role === \"listbox\";\n    const { menubar } = useMenuBarContext();\n\n    // Since there is the possibility of other tab focusable elements within the\n    // sheet and the menu items are programmatically focused, the menu's\n    // tabIndex needs to be set to `-1` while one of the child menu items are\n    // focused. This allows Shift+Tab correctly focuses the previous focusable\n    // element within the sheet. Since `onFocus` and `onBlur` will be bubbled up\n    // to the menu widget each time a new MenuItem is focused, only disable the\n    // focused state if the blur event is fired without another focus event\n    // within an animation frame.\n    const [sheetMenuFocused, setSheetMenuFocused] = useState(false);\n    const sheetBlurredFame = useRef(0);\n    const menuBarContext = useMenuBarProvider({\n      root: false,\n      menubar,\n      hoverTimeout: menubar ? 0 : undefined,\n      defaultActiveId: id,\n    });\n    const { movementProps, movementContext } = useKeyboardMovementProvider({\n      onClick,\n      onFocus(event) {\n        onFocus(event);\n\n        if (!isSheet) {\n          return;\n        }\n\n        window.cancelAnimationFrame(sheetBlurredFame.current);\n        setSheetMenuFocused(true);\n      },\n      onKeyDown,\n      horizontal,\n      loopable: true,\n      searchable: true,\n      programmatic: true,\n      includeDisabled: true,\n      getDefaultFocusedIndex,\n    });\n\n    return (\n      <MenuWidgetKeyboardProvider disabled={isListbox} value={movementContext}>\n        <MenuBarProvider value={menuBarContext}>\n          <div\n            aria-orientation={horizontal ? \"horizontal\" : undefined}\n            {...remaining}\n            {...(isListbox ? { onClick, onFocus, onKeyDown } : movementProps)}\n            id={id}\n            ref={ref}\n            role={role}\n            className={menu({\n              className,\n              elevated: !disableElevation && !isSheet,\n              horizontal,\n            })}\n            tabIndex={isSheet && !sheetMenuFocused ? 0 : tabIndex}\n            onBlur={(event) => {\n              onBlur(event);\n              if (!isSheet) {\n                return;\n              }\n\n              sheetBlurredFame.current = window.requestAnimationFrame(() => {\n                setSheetMenuFocused(false);\n              });\n            }}\n          >\n            <List\n              {...listProps}\n              style={listStyle ?? listProps?.style}\n              className={listClassName || listProps?.className}\n              horizontal={horizontal}\n              onClick={(event) => {\n                listProps?.onClick?.(event);\n\n                // this makes it so you can click on the menu/list without\n                // closing the menu\n                if (event.target === event.currentTarget) {\n                  event.stopPropagation();\n                }\n\n                // This might be a test only workaround since clicking links move focus\n                // somewhere else\n                if (event.target instanceof HTMLElement) {\n                  cancelUnmountFocus.current = event.currentTarget.contains(\n                    event.target.closest(\"a\")\n                  );\n                }\n              }}\n            >\n              {children}\n            </List>\n          </div>\n        </MenuBarProvider>\n      </MenuWidgetKeyboardProvider>\n    );\n  }\n);\n"],"names":["cnb","forwardRef","useRef","useState","List","useKeyboardMovementProvider","bem","MenuWidgetKeyboardProvider","MenuBarProvider","useMenuBarContext","useMenuBarProvider","styles","noop","menu","options","className","horizontal","elevated","MenuWidget","props","ref","id","role","listStyle","listClassName","listProps","children","onClick","onBlur","onFocus","onKeyDown","tabIndex","isSheet","disableElevation","cancelUnmountFocus","getDefaultFocusedIndex","remaining","isListbox","menubar","sheetMenuFocused","setSheetMenuFocused","sheetBlurredFame","menuBarContext","root","hoverTimeout","undefined","defaultActiveId","movementProps","movementContext","event","window","cancelAnimationFrame","current","loopable","searchable","programmatic","includeDisabled","disabled","value","div","aria-orientation","requestAnimationFrame","style","target","currentTarget","stopPropagation","HTMLElement","contains","closest"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,UAAU,EAAEC,MAAM,EAAEC,QAAQ,QAA6B,QAAQ;AAC1E,SAASC,IAAI,QAAQ,kBAAkB;AAEvC,SAASC,2BAA2B,QAAQ,6CAA6C;AAEzF,SAASC,GAAG,QAAQ,kBAAkB;AAEtC,SAASC,0BAA0B,QAAQ,kCAAkC;AAC7E,SACEC,eAAe,EACfC,iBAAiB,EACjBC,kBAAkB,QACb,0BAA0B;AAEjC,MAAMC,SAASL,IAAI;AACnB,MAAMM,OAAO;AACX,aAAa;AACf;AAWA;;CAEC,GACD,OAAO,SAASC,KAAKC,UAAgC,CAAC,CAAC;IACrD,MAAM,EAAEC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAE,GAAGH;IAE5C,OAAOd,IAAIW,OAAO;QAAEK;QAAYC;IAAS,IAAIF;AAC/C;AAeA;;;;;;;;;CASC,GACD,OAAO,MAAMG,2BAAajB,WACxB,SAASiB,WAAWC,KAAK,EAAEC,GAAG;IAC5B,MAAM,EACJC,EAAE,EACFC,OAAO,MAAM,EACbP,SAAS,EACTQ,SAAS,EACTC,aAAa,EACbC,SAAS,EACTC,QAAQ,EACRC,OAAO,EACPC,SAAShB,IAAI,EACbiB,UAAUjB,IAAI,EACdkB,YAAYlB,IAAI,EAChBmB,WAAW,CAAC,CAAC,EACbC,OAAO,EACPhB,UAAU,EACViB,gBAAgB,EAChBC,kBAAkB,EAClBC,sBAAsB,EACtB,GAAGC,WACJ,GAAGjB;IACJ,MAAMkB,YAAYf,SAAS;IAC3B,MAAM,EAAEgB,OAAO,EAAE,GAAG7B;IAEpB,4EAA4E;IAC5E,oEAAoE;IACpE,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,6BAA6B;IAC7B,MAAM,CAAC8B,kBAAkBC,oBAAoB,GAAGrC,SAAS;IACzD,MAAMsC,mBAAmBvC,OAAO;IAChC,MAAMwC,iBAAiBhC,mBAAmB;QACxCiC,MAAM;QACNL;QACAM,cAAcN,UAAU,IAAIO;QAC5BC,iBAAiBzB;IACnB;IACA,MAAM,EAAE0B,aAAa,EAAEC,eAAe,EAAE,GAAG3C,4BAA4B;QACrEsB;QACAE,SAAQoB,KAAK;YACXpB,QAAQoB;YAER,IAAI,CAACjB,SAAS;gBACZ;YACF;YAEAkB,OAAOC,oBAAoB,CAACV,iBAAiBW,OAAO;YACpDZ,oBAAoB;QACtB;QACAV;QACAd;QACAqC,UAAU;QACVC,YAAY;QACZC,cAAc;QACdC,iBAAiB;QACjBrB;IACF;IAEA,qBACE,KAAC5B;QAA2BkD,UAAUpB;QAAWqB,OAAOV;kBACtD,cAAA,KAACxC;YAAgBkD,OAAOhB;sBACtB,cAAA,KAACiB;gBACCC,oBAAkB5C,aAAa,eAAe6B;gBAC7C,GAAGT,SAAS;gBACZ,GAAIC,YAAY;oBAAEV;oBAASE;oBAASC;gBAAU,IAAIiB,aAAa;gBAChE1B,IAAIA;gBACJD,KAAKA;gBACLE,MAAMA;gBACNP,WAAWF,KAAK;oBACdE;oBACAE,UAAU,CAACgB,oBAAoB,CAACD;oBAChChB;gBACF;gBACAe,UAAUC,WAAW,CAACO,mBAAmB,IAAIR;gBAC7CH,QAAQ,CAACqB;oBACPrB,OAAOqB;oBACP,IAAI,CAACjB,SAAS;wBACZ;oBACF;oBAEAS,iBAAiBW,OAAO,GAAGF,OAAOW,qBAAqB,CAAC;wBACtDrB,oBAAoB;oBACtB;gBACF;0BAEA,cAAA,KAACpC;oBACE,GAAGqB,SAAS;oBACbqC,OAAOvC,aAAaE,WAAWqC;oBAC/B/C,WAAWS,iBAAiBC,WAAWV;oBACvCC,YAAYA;oBACZW,SAAS,CAACsB;wBACRxB,WAAWE,UAAUsB;wBAErB,0DAA0D;wBAC1D,mBAAmB;wBACnB,IAAIA,MAAMc,MAAM,KAAKd,MAAMe,aAAa,EAAE;4BACxCf,MAAMgB,eAAe;wBACvB;wBAEA,uEAAuE;wBACvE,iBAAiB;wBACjB,IAAIhB,MAAMc,MAAM,YAAYG,aAAa;4BACvChC,mBAAmBkB,OAAO,GAAGH,MAAMe,aAAa,CAACG,QAAQ,CACvDlB,MAAMc,MAAM,CAACK,OAAO,CAAC;wBAEzB;oBACF;8BAEC1C;;;;;AAMb,GACA"}
+{"version":3,"sources":["../../src/menu/MenuWidget.tsx"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport { forwardRef, useRef, useState, type HTMLAttributes } from \"react\";\nimport { List } from \"../list/List.js\";\nimport { type GetDefaultFocusedIndex } from \"../movement/types.js\";\nimport { useKeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\nimport { type NonNullMutableRef } from \"../types.js\";\nimport { bem } from \"../utils/bem.js\";\nimport { type MenuListConvenienceProps } from \"./Menu.js\";\nimport { MenuWidgetKeyboardProvider } from \"./MenuWidgetKeyboardProvider.js\";\nimport {\n  MenuBarProvider,\n  useMenuBarContext,\n  useMenuBarProvider,\n} from \"./useMenuBarProvider.js\";\n\nconst styles = bem(\"rmd-menu\");\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * @since 6.0.0\n */\nexport interface MenuClassNameOptions {\n  className?: string;\n  horizontal?: boolean;\n  elevated?: boolean;\n}\n\n/**\n * @since 6.0.0\n */\nexport function menu(options: MenuClassNameOptions = {}): string {\n  const { className, horizontal, elevated } = options;\n\n  return cnb(styles({ horizontal, elevated }), className);\n}\n\n/**\n * @internal\n */\nexport interface MenuWidgetProps\n  extends HTMLAttributes<HTMLDivElement>,\n    MenuListConvenienceProps {\n  isSheet: boolean;\n  horizontal: boolean;\n  disableElevation?: boolean;\n  cancelUnmountFocus: NonNullMutableRef<boolean>;\n  getDefaultFocusedIndex?: GetDefaultFocusedIndex;\n}\n\n/**\n * **Client Component**\n *\n * This component was added to support the listbox role and the `useId()` hook.\n * If the `temporary` prop is set, the `MenuItem`'s ids will not be the same the\n * next time the menu opens, so the aria-activedescendant will point to a\n * non-existing id\n *\n * @internal\n */\nexport const MenuWidget = forwardRef<HTMLDivElement, MenuWidgetProps>(\n  function MenuWidget(props, ref) {\n    const {\n      id,\n      role = \"menu\",\n      className,\n      listStyle,\n      listClassName,\n      listProps,\n      children,\n      onClick,\n      onBlur = noop,\n      onFocus = noop,\n      onKeyDown = noop,\n      tabIndex = -1,\n      isSheet,\n      horizontal,\n      disableElevation,\n      cancelUnmountFocus,\n      getDefaultFocusedIndex,\n      ...remaining\n    } = props;\n    const isListbox = role === \"listbox\";\n    const { menubar } = useMenuBarContext();\n\n    // Since there is the possibility of other tab focusable elements within the\n    // sheet and the menu items are programmatically focused, the menu's\n    // tabIndex needs to be set to `-1` while one of the child menu items are\n    // focused. This allows Shift+Tab correctly focuses the previous focusable\n    // element within the sheet. Since `onFocus` and `onBlur` will be bubbled up\n    // to the menu widget each time a new MenuItem is focused, only disable the\n    // focused state if the blur event is fired without another focus event\n    // within an animation frame.\n    const [sheetMenuFocused, setSheetMenuFocused] = useState(false);\n    const sheetBlurredFame = useRef(0);\n    const menuBarContext = useMenuBarProvider({\n      root: false,\n      menubar,\n      hoverTimeout: menubar ? 0 : undefined,\n      defaultActiveId: id,\n    });\n    const { movementProps, movementContext } = useKeyboardMovementProvider({\n      onClick,\n      onFocus(event) {\n        onFocus(event);\n\n        if (!isSheet) {\n          return;\n        }\n\n        window.cancelAnimationFrame(sheetBlurredFame.current);\n        setSheetMenuFocused(true);\n      },\n      onKeyDown,\n      horizontal,\n      loopable: true,\n      searchable: true,\n      programmatic: true,\n      includeDisabled: true,\n      getDefaultFocusedIndex,\n    });\n\n    return (\n      <MenuWidgetKeyboardProvider disabled={isListbox} value={movementContext}>\n        <MenuBarProvider value={menuBarContext}>\n          <div\n            aria-orientation={horizontal ? \"horizontal\" : undefined}\n            {...remaining}\n            {...(isListbox ? { onClick, onFocus, onKeyDown } : movementProps)}\n            id={id}\n            ref={ref}\n            role={role}\n            className={menu({\n              className,\n              elevated: !disableElevation && !isSheet,\n              horizontal,\n            })}\n            tabIndex={isSheet && !sheetMenuFocused ? 0 : tabIndex}\n            onBlur={(event) => {\n              onBlur(event);\n              if (!isSheet) {\n                return;\n              }\n\n              sheetBlurredFame.current = window.requestAnimationFrame(() => {\n                setSheetMenuFocused(false);\n              });\n            }}\n          >\n            <List\n              {...listProps}\n              style={listStyle ?? listProps?.style}\n              className={listClassName || listProps?.className}\n              horizontal={horizontal}\n              onClick={(event) => {\n                listProps?.onClick?.(event);\n\n                // this makes it so you can click on the menu/list without\n                // closing the menu\n                if (event.target === event.currentTarget) {\n                  event.stopPropagation();\n                }\n\n                // This might be a test only workaround since clicking links move focus\n                // somewhere else\n                if (event.target instanceof HTMLElement) {\n                  cancelUnmountFocus.current = event.currentTarget.contains(\n                    event.target.closest(\"a\")\n                  );\n                }\n              }}\n            >\n              {children}\n            </List>\n          </div>\n        </MenuBarProvider>\n      </MenuWidgetKeyboardProvider>\n    );\n  }\n);\n"],"names":["cnb","forwardRef","useRef","useState","List","useKeyboardMovementProvider","bem","MenuWidgetKeyboardProvider","MenuBarProvider","useMenuBarContext","useMenuBarProvider","styles","noop","menu","options","className","horizontal","elevated","MenuWidget","props","ref","id","role","listStyle","listClassName","listProps","children","onClick","onBlur","onFocus","onKeyDown","tabIndex","isSheet","disableElevation","cancelUnmountFocus","getDefaultFocusedIndex","remaining","isListbox","menubar","sheetMenuFocused","setSheetMenuFocused","sheetBlurredFame","menuBarContext","root","hoverTimeout","undefined","defaultActiveId","movementProps","movementContext","event","window","cancelAnimationFrame","current","loopable","searchable","programmatic","includeDisabled","disabled","value","div","aria-orientation","requestAnimationFrame","style","target","currentTarget","stopPropagation","HTMLElement","contains","closest"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,UAAU,EAAEC,MAAM,EAAEC,QAAQ,QAA6B,QAAQ;AAC1E,SAASC,IAAI,QAAQ,kBAAkB;AAEvC,SAASC,2BAA2B,QAAQ,6CAA6C;AAEzF,SAASC,GAAG,QAAQ,kBAAkB;AAEtC,SAASC,0BAA0B,QAAQ,kCAAkC;AAC7E,SACEC,eAAe,EACfC,iBAAiB,EACjBC,kBAAkB,QACb,0BAA0B;AAEjC,MAAMC,SAASL,IAAI;AACnB,MAAMM,OAAO;AACX,aAAa;AACf;AAWA;;CAEC,GACD,OAAO,SAASC,KAAKC,UAAgC,CAAC,CAAC;IACrD,MAAM,EAAEC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAE,GAAGH;IAE5C,OAAOd,IAAIW,OAAO;QAAEK;QAAYC;IAAS,IAAIF;AAC/C;AAeA;;;;;;;;;CASC,GACD,OAAO,MAAMG,2BAAajB,WACxB,SAASiB,WAAWC,KAAK,EAAEC,GAAG;IAC5B,MAAM,EACJC,EAAE,EACFC,OAAO,MAAM,EACbP,SAAS,EACTQ,SAAS,EACTC,aAAa,EACbC,SAAS,EACTC,QAAQ,EACRC,OAAO,EACPC,SAAShB,IAAI,EACbiB,UAAUjB,IAAI,EACdkB,YAAYlB,IAAI,EAChBmB,WAAW,CAAC,CAAC,EACbC,OAAO,EACPhB,UAAU,EACViB,gBAAgB,EAChBC,kBAAkB,EAClBC,sBAAsB,EACtB,GAAGC,WACJ,GAAGjB;IACJ,MAAMkB,YAAYf,SAAS;IAC3B,MAAM,EAAEgB,OAAO,EAAE,GAAG7B;IAEpB,4EAA4E;IAC5E,oEAAoE;IACpE,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,6BAA6B;IAC7B,MAAM,CAAC8B,kBAAkBC,oBAAoB,GAAGrC,SAAS;IACzD,MAAMsC,mBAAmBvC,OAAO;IAChC,MAAMwC,iBAAiBhC,mBAAmB;QACxCiC,MAAM;QACNL;QACAM,cAAcN,UAAU,IAAIO;QAC5BC,iBAAiBzB;IACnB;IACA,MAAM,EAAE0B,aAAa,EAAEC,eAAe,EAAE,GAAG3C,4BAA4B;QACrEsB;QACAE,SAAQoB,KAAK;YACXpB,QAAQoB;YAER,IAAI,CAACjB,SAAS;gBACZ;YACF;YAEAkB,OAAOC,oBAAoB,CAACV,iBAAiBW,OAAO;YACpDZ,oBAAoB;QACtB;QACAV;QACAd;QACAqC,UAAU;QACVC,YAAY;QACZC,cAAc;QACdC,iBAAiB;QACjBrB;IACF;IAEA,qBACE,KAAC5B;QAA2BkD,UAAUpB;QAAWqB,OAAOV;kBACtD,cAAA,KAACxC;YAAgBkD,OAAOhB;sBACtB,cAAA,KAACiB;gBACCC,oBAAkB5C,aAAa,eAAe6B;gBAC7C,GAAGT,SAAS;gBACZ,GAAIC,YAAY;oBAAEV;oBAASE;oBAASC;gBAAU,IAAIiB,aAAa;gBAChE1B,IAAIA;gBACJD,KAAKA;gBACLE,MAAMA;gBACNP,WAAWF,KAAK;oBACdE;oBACAE,UAAU,CAACgB,oBAAoB,CAACD;oBAChChB;gBACF;gBACAe,UAAUC,WAAW,CAACO,mBAAmB,IAAIR;gBAC7CH,QAAQ,CAACqB;oBACPrB,OAAOqB;oBACP,IAAI,CAACjB,SAAS;wBACZ;oBACF;oBAEAS,iBAAiBW,OAAO,GAAGF,OAAOW,qBAAqB,CAAC;wBACtDrB,oBAAoB;oBACtB;gBACF;0BAEA,cAAA,KAACpC;oBACE,GAAGqB,SAAS;oBACbqC,OAAOvC,aAAaE,WAAWqC;oBAC/B/C,WAAWS,iBAAiBC,WAAWV;oBACvCC,YAAYA;oBACZW,SAAS,CAACsB;wBACRxB,WAAWE,UAAUsB;wBAErB,0DAA0D;wBAC1D,mBAAmB;wBACnB,IAAIA,MAAMc,MAAM,KAAKd,MAAMe,aAAa,EAAE;4BACxCf,MAAMgB,eAAe;wBACvB;wBAEA,uEAAuE;wBACvE,iBAAiB;wBACjB,IAAIhB,MAAMc,MAAM,YAAYG,aAAa;4BACvChC,mBAAmBkB,OAAO,GAAGH,MAAMe,aAAa,CAACG,QAAQ,CACvDlB,MAAMc,MAAM,CAACK,OAAO,CAAC;wBAEzB;oBACF;8BAEC1C;;;;;AAMb,GACA"}

package/dist/menu/MenuWidgetKeyboardProvider.d.ts

@@ -1,7 +1,7 @@
 import { type ReactElement, type ReactNode } from "react";
 import { type KeyboardMovementContext } from "../movement/types.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface MenuWidgetKeyboardProviderProps {
@@ -12,7 +12,7 @@ export interface MenuWidgetKeyboardProviderProps {
 /**
  * **Client Component**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function MenuWidgetKeyboardProvider(props: MenuWidgetKeyboardProviderProps): ReactElement;

package/dist/menu/MenuWidgetKeyboardProvider.js

@@ -4,7 +4,7 @@ import { KeyboardMovementProvider } from "../movement/useKeyboardMovementProvide
 /**
  * **Client Component**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function MenuWidgetKeyboardProvider(props) {
     const { value, disabled, children } = props;

package/dist/menu/MenuWidgetKeyboardProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/menu/MenuWidgetKeyboardProvider.tsx"],"sourcesContent":["\"use client\";\nimport { type ReactElement, type ReactNode } from \"react\";\nimport { type KeyboardMovementContext } from \"../movement/types.js\";\nimport { KeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface MenuWidgetKeyboardProviderProps {\n  value: Readonly<KeyboardMovementContext>;\n  disabled: boolean;\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function MenuWidgetKeyboardProvider(\n  props: MenuWidgetKeyboardProviderProps\n): ReactElement {\n  const { value, disabled, children } = props;\n  if (disabled) {\n    return <>{children}</>;\n  }\n\n  return (\n    <KeyboardMovementProvider value={value}>\n      {children}\n    </KeyboardMovementProvider>\n  );\n}\n"],"names":["KeyboardMovementProvider","MenuWidgetKeyboardProvider","props","value","disabled","children"],"rangeMappings":";;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AAGA,SAASA,wBAAwB,QAAQ,6CAA6C;AAYtF;;;;;CAKC,GACD,OAAO,SAASC,2BACdC,KAAsC;IAEtC,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAGH;IACtC,IAAIE,UAAU;QACZ,qBAAO;sBAAGC;;IACZ;IAEA,qBACE,KAACL;QAAyBG,OAAOA;kBAC9BE;;AAGP"}
+{"version":3,"sources":["../../src/menu/MenuWidgetKeyboardProvider.tsx"],"sourcesContent":["\"use client\";\nimport { type ReactElement, type ReactNode } from \"react\";\nimport { type KeyboardMovementContext } from \"../movement/types.js\";\nimport { KeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface MenuWidgetKeyboardProviderProps {\n  value: Readonly<KeyboardMovementContext>;\n  disabled: boolean;\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * @since 6.0.0\n * @internal\n */\nexport function MenuWidgetKeyboardProvider(\n  props: MenuWidgetKeyboardProviderProps\n): ReactElement {\n  const { value, disabled, children } = props;\n  if (disabled) {\n    return <>{children}</>;\n  }\n\n  return (\n    <KeyboardMovementProvider value={value}>\n      {children}\n    </KeyboardMovementProvider>\n  );\n}\n"],"names":["KeyboardMovementProvider","MenuWidgetKeyboardProvider","props","value","disabled","children"],"rangeMappings":";;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AAGA,SAASA,wBAAwB,QAAQ,6CAA6C;AAYtF;;;;;CAKC,GACD,OAAO,SAASC,2BACdC,KAAsC;IAEtC,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAGH;IACtC,IAAIE,UAAU;QACZ,qBAAO;sBAAGC;;IACZ;IAEA,qBACE,KAACL;QAAyBG,OAAOA;kBAC9BE;;AAGP"}

package/dist/menu/useContextMenu.d.ts

@@ -1,7 +1,7 @@
 import type { MouseEvent, RefObject } from "react";
 import type { InitialCoords, PositionAnchor } from "../positioning/types.js";
 import type { UseStateObject } from "../types.js";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ContextMenuProps extends InitialCoords {
     "aria-label": string;
     anchor: PositionAnchor;
@@ -11,9 +11,8 @@ export interface ContextMenuProps extends InitialCoords {
     onRequestClose(): void;
 }
 /**
- * @remarks
- * \@since 5.0.0
- * \@since 6.0.0  Dropped most options since they are no longer required for the
+ * @since 5.0.0
+ * @since 6.0.0  Dropped most options since they are no longer required for the
  * context menu to work. Apply any `Menu` props directly to the `Menu` component
  * instead.
  */
@@ -34,9 +33,8 @@ export interface ContextMenuHookOptions {
     onContextMenu?<E extends HTMLElement>(event: MouseEvent<E>): void;
 }
 /**
- * @remarks
- * \@since 5.0.0
- * \@since 6.0.0 Renamed from `ContextMenuHookReturnValue` to
+ * @since 5.0.0
+ * @since 6.0.0 Renamed from `ContextMenuHookReturnValue` to
  * `ContextMenuImplementation` and dropped the `menuRef` and `menuNodeRef`
  * fields.
  */
@@ -47,8 +45,7 @@ export interface ContextMenuImplementation extends UseStateObject<"visible", boo
 /**
  * This hook controls the visibility and positioning for a context menu.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import type { ReactElement } from "react";
  * import [ Menu, MenuItem, useContextMenu ] from "@react-md/core":
@@ -70,9 +67,8 @@ export interface ContextMenuImplementation extends UseStateObject<"visible", boo
  * }
  * ```
  *
- * @remarks
- * \@since 5.0.0
- * \@since 6.0.0 No longer supports overriding most of the `Menu` props. The
+ * @since 5.0.0
+ * @since 6.0.0 No longer supports overriding most of the `Menu` props. The
  * props must be passed to the `Menu` component manually.
  */
 export declare function useContextMenu(options?: ContextMenuHookOptions): ContextMenuImplementation;

package/dist/menu/useContextMenu.js

@@ -7,8 +7,7 @@ const noop = ()=>{
 /**
  * This hook controls the visibility and positioning for a context menu.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * import type { ReactElement } from "react";
  * import [ Menu, MenuItem, useContextMenu ] from "@react-md/core":
@@ -30,9 +29,8 @@ const noop = ()=>{
  * }
  * ```
  *
- * @remarks
- * \@since 5.0.0
- * \@since 6.0.0 No longer supports overriding most of the `Menu` props. The
+ * @since 5.0.0
+ * @since 6.0.0 No longer supports overriding most of the `Menu` props. The
  * props must be passed to the `Menu` component manually.
  */ export function useContextMenu(options = {}) {
     const { anchor = BELOW_INNER_LEFT_ANCHOR, menuLabel = "Context Menu", onContextMenu = noop, preventScroll = true } = options;

package/dist/menu/useContextMenu.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/menu/useContextMenu.ts"],"sourcesContent":["\"use client\";\nimport type { MouseEvent, RefObject } from \"react\";\nimport { useCallback, useRef, useState } from \"react\";\nimport { BELOW_INNER_LEFT_ANCHOR } from \"../positioning/constants.js\";\nimport type { InitialCoords, PositionAnchor } from \"../positioning/types.js\";\nimport type { UseStateObject } from \"../types.js\";\n\n/** @remarks \\@since 6.0.0 */\nexport interface ContextMenuProps extends InitialCoords {\n  \"aria-label\": string;\n  anchor: PositionAnchor;\n  fixedTo: RefObject<HTMLElement>;\n  visible: boolean;\n  preventScroll: boolean;\n  onRequestClose(): void;\n}\n\n/**\n * @remarks\n * \\@since 5.0.0\n * \\@since 6.0.0  Dropped most options since they are no longer required for the\n * context menu to work. Apply any `Menu` props directly to the `Menu` component\n * instead.\n */\nexport interface ContextMenuHookOptions {\n  /**\n   * @defaultValue `BELOW_INNER_LEFT_ANCHOR`\n   * @see {@link BELOW_INNER_LEFT_ANCHOR}\n   */\n  anchor?: PositionAnchor;\n\n  /**\n   * @defaultValue `\"Context Menu\"`\n   */\n  menuLabel?: string;\n\n  /**\n   * @defaultValue `true`\n   */\n  preventScroll?: boolean;\n  onContextMenu?<E extends HTMLElement>(event: MouseEvent<E>): void;\n}\n\n/**\n * @remarks\n * \\@since 5.0.0\n * \\@since 6.0.0 Renamed from `ContextMenuHookReturnValue` to\n * `ContextMenuImplementation` and dropped the `menuRef` and `menuNodeRef`\n * fields.\n */\nexport interface ContextMenuImplementation\n  extends UseStateObject<\"visible\", boolean> {\n  menuProps: ContextMenuProps;\n  onContextMenu<E extends HTMLElement>(event: MouseEvent<E>): void;\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * This hook controls the visibility and positioning for a context menu.\n *\n * @example\n * Simple Example\n * ```tsx\n * import type { ReactElement } from \"react\";\n * import [ Menu, MenuItem, useContextMenu ] from \"@react-md/core\":\n *\n * function Example(): ReactElement {\n *   const { menuProps, onContextMenu } = useContextMenu();\n *\n *   return (\n *     <>\n *       <textarea onContextMenu={onContextMenu} />\n *       <Menu {...menuProps}>\n *         <MenuItem>Cut</MenuItem>\n *         <MenuItem>Copy</MenuItem>\n *         <MenuItem>Paste</MenuItem>\n *         <MenuItem>Undo</MenuItem>\n *       </Menu>\n *     </>\n *   );\n * }\n * ```\n *\n * @remarks\n * \\@since 5.0.0\n * \\@since 6.0.0 No longer supports overriding most of the `Menu` props. The\n * props must be passed to the `Menu` component manually.\n */\nexport function useContextMenu(\n  options: ContextMenuHookOptions = {}\n): ContextMenuImplementation {\n  const {\n    anchor = BELOW_INNER_LEFT_ANCHOR,\n    menuLabel = \"Context Menu\",\n    onContextMenu = noop,\n    preventScroll = true,\n  } = options;\n  const [coords, setCoords] = useState<InitialCoords>({});\n  const [visible, setVisible] = useState(false);\n  const fixedTo = useRef<HTMLElement>(null);\n  const onRequestClose = useCallback(() => {\n    setVisible(false);\n  }, []);\n\n  return {\n    visible,\n    setVisible,\n    menuProps: {\n      \"aria-label\": menuLabel,\n      anchor,\n      ...coords,\n      fixedTo,\n      visible,\n      onRequestClose,\n      preventScroll,\n    },\n    onContextMenu(event) {\n      onContextMenu(event);\n      if (event.isPropagationStopped()) {\n        return;\n      }\n\n      event.preventDefault();\n      event.stopPropagation();\n      setCoords({\n        initialX: event.clientX,\n        initialY: event.clientY,\n      });\n      setVisible(true);\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","BELOW_INNER_LEFT_ANCHOR","noop","useContextMenu","options","anchor","menuLabel","onContextMenu","preventScroll","coords","setCoords","visible","setVisible","fixedTo","onRequestClose","menuProps","event","isPropagationStopped","preventDefault","stopPropagation","initialX","clientX","initialY","clientY"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AAEA,SAASA,WAAW,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AACtD,SAASC,uBAAuB,QAAQ,8BAA8B;AAqDtE,MAAMC,OAAO;AACX,aAAa;AACf;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BC,GACD,OAAO,SAASC,eACdC,UAAkC,CAAC,CAAC;IAEpC,MAAM,EACJC,SAASJ,uBAAuB,EAChCK,YAAY,cAAc,EAC1BC,gBAAgBL,IAAI,EACpBM,gBAAgB,IAAI,EACrB,GAAGJ;IACJ,MAAM,CAACK,QAAQC,UAAU,GAAGV,SAAwB,CAAC;IACrD,MAAM,CAACW,SAASC,WAAW,GAAGZ,SAAS;IACvC,MAAMa,UAAUd,OAAoB;IACpC,MAAMe,iBAAiBhB,YAAY;QACjCc,WAAW;IACb,GAAG,EAAE;IAEL,OAAO;QACLD;QACAC;QACAG,WAAW;YACT,cAAcT;YACdD;YACA,GAAGI,MAAM;YACTI;YACAF;YACAG;YACAN;QACF;QACAD,eAAcS,KAAK;YACjBT,cAAcS;YACd,IAAIA,MAAMC,oBAAoB,IAAI;gBAChC;YACF;YAEAD,MAAME,cAAc;YACpBF,MAAMG,eAAe;YACrBT,UAAU;gBACRU,UAAUJ,MAAMK,OAAO;gBACvBC,UAAUN,MAAMO,OAAO;YACzB;YACAX,WAAW;QACb;IACF;AACF"}
+{"version":3,"sources":["../../src/menu/useContextMenu.ts"],"sourcesContent":["\"use client\";\nimport type { MouseEvent, RefObject } from \"react\";\nimport { useCallback, useRef, useState } from \"react\";\nimport { BELOW_INNER_LEFT_ANCHOR } from \"../positioning/constants.js\";\nimport type { InitialCoords, PositionAnchor } from \"../positioning/types.js\";\nimport type { UseStateObject } from \"../types.js\";\n\n/** @since 6.0.0 */\nexport interface ContextMenuProps extends InitialCoords {\n  \"aria-label\": string;\n  anchor: PositionAnchor;\n  fixedTo: RefObject<HTMLElement>;\n  visible: boolean;\n  preventScroll: boolean;\n  onRequestClose(): void;\n}\n\n/**\n * @since 5.0.0\n * @since 6.0.0  Dropped most options since they are no longer required for the\n * context menu to work. Apply any `Menu` props directly to the `Menu` component\n * instead.\n */\nexport interface ContextMenuHookOptions {\n  /**\n   * @defaultValue `BELOW_INNER_LEFT_ANCHOR`\n   * @see {@link BELOW_INNER_LEFT_ANCHOR}\n   */\n  anchor?: PositionAnchor;\n\n  /**\n   * @defaultValue `\"Context Menu\"`\n   */\n  menuLabel?: string;\n\n  /**\n   * @defaultValue `true`\n   */\n  preventScroll?: boolean;\n  onContextMenu?<E extends HTMLElement>(event: MouseEvent<E>): void;\n}\n\n/**\n * @since 5.0.0\n * @since 6.0.0 Renamed from `ContextMenuHookReturnValue` to\n * `ContextMenuImplementation` and dropped the `menuRef` and `menuNodeRef`\n * fields.\n */\nexport interface ContextMenuImplementation\n  extends UseStateObject<\"visible\", boolean> {\n  menuProps: ContextMenuProps;\n  onContextMenu<E extends HTMLElement>(event: MouseEvent<E>): void;\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * This hook controls the visibility and positioning for a context menu.\n *\n * @example Simple Example\n * ```tsx\n * import type { ReactElement } from \"react\";\n * import [ Menu, MenuItem, useContextMenu ] from \"@react-md/core\":\n *\n * function Example(): ReactElement {\n *   const { menuProps, onContextMenu } = useContextMenu();\n *\n *   return (\n *     <>\n *       <textarea onContextMenu={onContextMenu} />\n *       <Menu {...menuProps}>\n *         <MenuItem>Cut</MenuItem>\n *         <MenuItem>Copy</MenuItem>\n *         <MenuItem>Paste</MenuItem>\n *         <MenuItem>Undo</MenuItem>\n *       </Menu>\n *     </>\n *   );\n * }\n * ```\n *\n * @since 5.0.0\n * @since 6.0.0 No longer supports overriding most of the `Menu` props. The\n * props must be passed to the `Menu` component manually.\n */\nexport function useContextMenu(\n  options: ContextMenuHookOptions = {}\n): ContextMenuImplementation {\n  const {\n    anchor = BELOW_INNER_LEFT_ANCHOR,\n    menuLabel = \"Context Menu\",\n    onContextMenu = noop,\n    preventScroll = true,\n  } = options;\n  const [coords, setCoords] = useState<InitialCoords>({});\n  const [visible, setVisible] = useState(false);\n  const fixedTo = useRef<HTMLElement>(null);\n  const onRequestClose = useCallback(() => {\n    setVisible(false);\n  }, []);\n\n  return {\n    visible,\n    setVisible,\n    menuProps: {\n      \"aria-label\": menuLabel,\n      anchor,\n      ...coords,\n      fixedTo,\n      visible,\n      onRequestClose,\n      preventScroll,\n    },\n    onContextMenu(event) {\n      onContextMenu(event);\n      if (event.isPropagationStopped()) {\n        return;\n      }\n\n      event.preventDefault();\n      event.stopPropagation();\n      setCoords({\n        initialX: event.clientX,\n        initialY: event.clientY,\n      });\n      setVisible(true);\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","BELOW_INNER_LEFT_ANCHOR","noop","useContextMenu","options","anchor","menuLabel","onContextMenu","preventScroll","coords","setCoords","visible","setVisible","fixedTo","onRequestClose","menuProps","event","isPropagationStopped","preventDefault","stopPropagation","initialX","clientX","initialY","clientY"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AAEA,SAASA,WAAW,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AACtD,SAASC,uBAAuB,QAAQ,8BAA8B;AAmDtE,MAAMC,OAAO;AACX,aAAa;AACf;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BC,GACD,OAAO,SAASC,eACdC,UAAkC,CAAC,CAAC;IAEpC,MAAM,EACJC,SAASJ,uBAAuB,EAChCK,YAAY,cAAc,EAC1BC,gBAAgBL,IAAI,EACpBM,gBAAgB,IAAI,EACrB,GAAGJ;IACJ,MAAM,CAACK,QAAQC,UAAU,GAAGV,SAAwB,CAAC;IACrD,MAAM,CAACW,SAASC,WAAW,GAAGZ,SAAS;IACvC,MAAMa,UAAUd,OAAoB;IACpC,MAAMe,iBAAiBhB,YAAY;QACjCc,WAAW;IACb,GAAG,EAAE;IAEL,OAAO;QACLD;QACAC;QACAG,WAAW;YACT,cAAcT;YACdD;YACA,GAAGI,MAAM;YACTI;YACAF;YACAG;YACAN;QACF;QACAD,eAAcS,KAAK;YACjBT,cAAcS;YACd,IAAIA,MAAMC,oBAAoB,IAAI;gBAChC;YACF;YAEAD,MAAME,cAAc;YACpBF,MAAMG,eAAe;YACrBT,UAAU;gBACRU,UAAUJ,MAAMK,OAAO;gBACvBC,UAAUN,MAAMO,OAAO;YACzB;YACAX,WAAW;QACb;IACF;AACF"}

package/dist/menu/useMenuBarProvider.d.ts

@@ -2,8 +2,8 @@
 import type { HoverModeContext } from "../hoverMode/useHoverModeProvider.js";
 /**
  * @internal
- * @remarks \@since 5.0.0
- * @remarks \@since 6.0.0 Updated to use the new `HoverModeContext` behavior.
+ * @since 5.0.0
+ * @since 6.0.0 Updated to use the new `HoverModeContext` behavior.
  */
 export interface MenuBarContext extends HoverModeContext {
     root: boolean;
@@ -12,17 +12,17 @@ export interface MenuBarContext extends HoverModeContext {
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const MenuBarProvider: import("react").Provider<MenuBarContext>;
 /**
  * @internal
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */
 export declare function useMenuBarContext(): Readonly<MenuBarContext>;
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface MenuBarProviderOptions {
     root: boolean;
@@ -33,6 +33,6 @@ export interface MenuBarProviderOptions {
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useMenuBarProvider(options: MenuBarProviderOptions): Readonly<MenuBarContext>;

package/dist/menu/useMenuBarProvider.js

@@ -10,17 +10,17 @@ const context = createContext({
 context.displayName = "MenuBar";
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const { Provider: MenuBarProvider } = context;
 /**
  * @internal
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */ export function useMenuBarContext() {
     return useContext(context);
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function useMenuBarProvider(options) {
     const { hoverTimeout, root, menubar, defaultActiveId = "" } = options;
     const hoverMode = useHoverModeProvider({

package/dist/menu/useMenuBarProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/menu/useMenuBarProvider.ts"],"sourcesContent":["\"use client\";\nimport { createContext, useContext, useMemo } from \"react\";\nimport type { HoverModeContext } from \"../hoverMode/useHoverModeProvider.js\";\nimport {\n  createHoverModeContext,\n  useHoverModeProvider,\n} from \"../hoverMode/useHoverModeProvider.js\";\n\n/**\n * @internal\n * @remarks \\@since 5.0.0\n * @remarks \\@since 6.0.0 Updated to use the new `HoverModeContext` behavior.\n */\nexport interface MenuBarContext extends HoverModeContext {\n  root: boolean;\n  menubar: boolean;\n  menuitem: boolean;\n}\n\nconst context = createContext<MenuBarContext>({\n  ...createHoverModeContext(),\n  root: false,\n  menubar: false,\n  menuitem: false,\n});\ncontext.displayName = \"MenuBar\";\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport const { Provider: MenuBarProvider } = context;\n\n/**\n * @internal\n * @remarks \\@since 5.0.0\n */\nexport function useMenuBarContext(): Readonly<MenuBarContext> {\n  return useContext(context);\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface MenuBarProviderOptions {\n  root: boolean;\n  menubar: boolean;\n  hoverTimeout: number | undefined;\n\n  /** @defaultValue `\"\"` */\n  defaultActiveId?: string;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport function useMenuBarProvider(\n  options: MenuBarProviderOptions\n): Readonly<MenuBarContext> {\n  const { hoverTimeout, root, menubar, defaultActiveId = \"\" } = options;\n\n  const hoverMode = useHoverModeProvider({\n    hoverTimeout,\n    forceRerender: true,\n    defaultActiveId,\n  });\n\n  if (defaultActiveId) {\n    // without this \"fix\", first-level nested dropdown menus will only disable\n    // the animation the first time they are shown.\n    hoverMode.animatedOnceRef.current = true;\n  }\n\n  return useMemo<MenuBarContext>(\n    () => ({\n      // when not within a menubar, disable all the hover mode functionality by\n      // creating an empty hover mode context. This makes it so nested dropdown\n      // menus don't trigger the hover mode timeouts and behavior\n      ...(menubar ? hoverMode : createHoverModeContext()),\n      root,\n      menubar,\n      menuitem: true,\n    }),\n    [hoverMode, menubar, root]\n  );\n}\n"],"names":["createContext","useContext","useMemo","createHoverModeContext","useHoverModeProvider","context","root","menubar","menuitem","displayName","Provider","MenuBarProvider","useMenuBarContext","useMenuBarProvider","options","hoverTimeout","defaultActiveId","hoverMode","forceRerender","animatedOnceRef","current"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,aAAa,EAAEC,UAAU,EAAEC,OAAO,QAAQ,QAAQ;AAE3D,SACEC,sBAAsB,EACtBC,oBAAoB,QACf,uCAAuC;AAa9C,MAAMC,UAAUL,cAA8B;IAC5C,GAAGG,wBAAwB;IAC3BG,MAAM;IACNC,SAAS;IACTC,UAAU;AACZ;AACAH,QAAQI,WAAW,GAAG;AAEtB;;;CAGC,GACD,OAAO,MAAM,EAAEC,UAAUC,eAAe,EAAE,GAAGN,QAAQ;AAErD;;;CAGC,GACD,OAAO,SAASO;IACd,OAAOX,WAAWI;AACpB;AAeA;;;CAGC,GACD,OAAO,SAASQ,mBACdC,OAA+B;IAE/B,MAAM,EAAEC,YAAY,EAAET,IAAI,EAAEC,OAAO,EAAES,kBAAkB,EAAE,EAAE,GAAGF;IAE9D,MAAMG,YAAYb,qBAAqB;QACrCW;QACAG,eAAe;QACfF;IACF;IAEA,IAAIA,iBAAiB;QACnB,0EAA0E;QAC1E,+CAA+C;QAC/CC,UAAUE,eAAe,CAACC,OAAO,GAAG;IACtC;IAEA,OAAOlB,QACL,IAAO,CAAA;YACL,yEAAyE;YACzE,yEAAyE;YACzE,2DAA2D;YAC3D,GAAIK,UAAUU,YAAYd,wBAAwB;YAClDG;YACAC;YACAC,UAAU;QACZ,CAAA,GACA;QAACS;QAAWV;QAASD;KAAK;AAE9B"}
+{"version":3,"sources":["../../src/menu/useMenuBarProvider.ts"],"sourcesContent":["\"use client\";\nimport { createContext, useContext, useMemo } from \"react\";\nimport type { HoverModeContext } from \"../hoverMode/useHoverModeProvider.js\";\nimport {\n  createHoverModeContext,\n  useHoverModeProvider,\n} from \"../hoverMode/useHoverModeProvider.js\";\n\n/**\n * @internal\n * @since 5.0.0\n * @since 6.0.0 Updated to use the new `HoverModeContext` behavior.\n */\nexport interface MenuBarContext extends HoverModeContext {\n  root: boolean;\n  menubar: boolean;\n  menuitem: boolean;\n}\n\nconst context = createContext<MenuBarContext>({\n  ...createHoverModeContext(),\n  root: false,\n  menubar: false,\n  menuitem: false,\n});\ncontext.displayName = \"MenuBar\";\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport const { Provider: MenuBarProvider } = context;\n\n/**\n * @internal\n * @since 5.0.0\n */\nexport function useMenuBarContext(): Readonly<MenuBarContext> {\n  return useContext(context);\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport interface MenuBarProviderOptions {\n  root: boolean;\n  menubar: boolean;\n  hoverTimeout: number | undefined;\n\n  /** @defaultValue `\"\"` */\n  defaultActiveId?: string;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport function useMenuBarProvider(\n  options: MenuBarProviderOptions\n): Readonly<MenuBarContext> {\n  const { hoverTimeout, root, menubar, defaultActiveId = \"\" } = options;\n\n  const hoverMode = useHoverModeProvider({\n    hoverTimeout,\n    forceRerender: true,\n    defaultActiveId,\n  });\n\n  if (defaultActiveId) {\n    // without this \"fix\", first-level nested dropdown menus will only disable\n    // the animation the first time they are shown.\n    hoverMode.animatedOnceRef.current = true;\n  }\n\n  return useMemo<MenuBarContext>(\n    () => ({\n      // when not within a menubar, disable all the hover mode functionality by\n      // creating an empty hover mode context. This makes it so nested dropdown\n      // menus don't trigger the hover mode timeouts and behavior\n      ...(menubar ? hoverMode : createHoverModeContext()),\n      root,\n      menubar,\n      menuitem: true,\n    }),\n    [hoverMode, menubar, root]\n  );\n}\n"],"names":["createContext","useContext","useMemo","createHoverModeContext","useHoverModeProvider","context","root","menubar","menuitem","displayName","Provider","MenuBarProvider","useMenuBarContext","useMenuBarProvider","options","hoverTimeout","defaultActiveId","hoverMode","forceRerender","animatedOnceRef","current"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,aAAa,EAAEC,UAAU,EAAEC,OAAO,QAAQ,QAAQ;AAE3D,SACEC,sBAAsB,EACtBC,oBAAoB,QACf,uCAAuC;AAa9C,MAAMC,UAAUL,cAA8B;IAC5C,GAAGG,wBAAwB;IAC3BG,MAAM;IACNC,SAAS;IACTC,UAAU;AACZ;AACAH,QAAQI,WAAW,GAAG;AAEtB;;;CAGC,GACD,OAAO,MAAM,EAAEC,UAAUC,eAAe,EAAE,GAAGN,QAAQ;AAErD;;;CAGC,GACD,OAAO,SAASO;IACd,OAAOX,WAAWI;AACpB;AAeA;;;CAGC,GACD,OAAO,SAASQ,mBACdC,OAA+B;IAE/B,MAAM,EAAEC,YAAY,EAAET,IAAI,EAAEC,OAAO,EAAES,kBAAkB,EAAE,EAAE,GAAGF;IAE9D,MAAMG,YAAYb,qBAAqB;QACrCW;QACAG,eAAe;QACfF;IACF;IAEA,IAAIA,iBAAiB;QACnB,0EAA0E;QAC1E,+CAA+C;QAC/CC,UAAUE,eAAe,CAACC,OAAO,GAAG;IACtC;IAEA,OAAOlB,QACL,IAAO,CAAA;YACL,yEAAyE;YACzE,yEAAyE;YACzE,2DAA2D;YAC3D,GAAIK,UAAUU,YAAYd,wBAAwB;YAClDG;YACAC;YACAC,UAAU;QACZ,CAAA,GACA;QAACS;QAAWV;QAASD;KAAK;AAE9B"}

package/dist/menu/utils.d.ts

@@ -1,7 +1,7 @@
 import type { FloatingActionButtonPosition } from "../button/FloatingActionButton.js";
 import type { PositionAnchor } from "../positioning/types.js";
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 interface DefaultAnchorOptions {
@@ -12,7 +12,7 @@ interface DefaultAnchorOptions {
     horizontal: boolean;
 }
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const getDefaultAnchor: (options: DefaultAnchorOptions) => PositionAnchor;

package/dist/menu/utils.js

@@ -1,6 +1,6 @@
 import { BELOW_CENTER_ANCHOR, BELOW_INNER_LEFT_ANCHOR, BOTTOM_INNER_LEFT_ANCHOR, BOTTOM_INNER_RIGHT_ANCHOR, CENTER_RIGHT_ANCHOR, TOP_INNER_LEFT_ANCHOR, TOP_INNER_RIGHT_ANCHOR, TOP_RIGHT_ANCHOR } from "../positioning/constants.js";
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const getDefaultAnchor = (options)=>{
     const { anchor, menubar, menuitem, floating, horizontal } = options;

package/dist/menu/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/menu/utils.ts"],"sourcesContent":["import type { FloatingActionButtonPosition } from \"../button/FloatingActionButton.js\";\nimport {\n  BELOW_CENTER_ANCHOR,\n  BELOW_INNER_LEFT_ANCHOR,\n  BOTTOM_INNER_LEFT_ANCHOR,\n  BOTTOM_INNER_RIGHT_ANCHOR,\n  CENTER_RIGHT_ANCHOR,\n  TOP_INNER_LEFT_ANCHOR,\n  TOP_INNER_RIGHT_ANCHOR,\n  TOP_RIGHT_ANCHOR,\n} from \"../positioning/constants.js\";\nimport type { PositionAnchor } from \"../positioning/types.js\";\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\ninterface DefaultAnchorOptions {\n  anchor?: PositionAnchor;\n  menubar: boolean;\n  menuitem: boolean;\n  floating?: FloatingActionButtonPosition;\n  horizontal: boolean;\n}\n\n/**\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const getDefaultAnchor = (\n  options: DefaultAnchorOptions\n): PositionAnchor => {\n  const { anchor, menubar, menuitem, floating, horizontal } = options;\n  if (anchor) {\n    return anchor;\n  }\n\n  switch (floating) {\n    case \"bottom-left\":\n      return BOTTOM_INNER_LEFT_ANCHOR;\n    case \"bottom-right\":\n      return BOTTOM_INNER_RIGHT_ANCHOR;\n    case \"top-left\":\n      return TOP_INNER_LEFT_ANCHOR;\n    case \"top-right\":\n      return TOP_INNER_RIGHT_ANCHOR;\n  }\n\n  if (menubar) {\n    return menuitem ? CENTER_RIGHT_ANCHOR : BELOW_INNER_LEFT_ANCHOR;\n  }\n\n  if (horizontal) {\n    return BELOW_CENTER_ANCHOR;\n  }\n\n  if (menuitem) {\n    return TOP_RIGHT_ANCHOR;\n  }\n\n  return TOP_INNER_RIGHT_ANCHOR;\n};\n"],"names":["BELOW_CENTER_ANCHOR","BELOW_INNER_LEFT_ANCHOR","BOTTOM_INNER_LEFT_ANCHOR","BOTTOM_INNER_RIGHT_ANCHOR","CENTER_RIGHT_ANCHOR","TOP_INNER_LEFT_ANCHOR","TOP_INNER_RIGHT_ANCHOR","TOP_RIGHT_ANCHOR","getDefaultAnchor","options","anchor","menubar","menuitem","floating","horizontal"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AACA,SACEA,mBAAmB,EACnBC,uBAAuB,EACvBC,wBAAwB,EACxBC,yBAAyB,EACzBC,mBAAmB,EACnBC,qBAAqB,EACrBC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B;AAerC;;;CAGC,GACD,OAAO,MAAMC,mBAAmB,CAC9BC;IAEA,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,QAAQ,EAAEC,QAAQ,EAAEC,UAAU,EAAE,GAAGL;IAC5D,IAAIC,QAAQ;QACV,OAAOA;IACT;IAEA,OAAQG;QACN,KAAK;YACH,OAAOX;QACT,KAAK;YACH,OAAOC;QACT,KAAK;YACH,OAAOE;QACT,KAAK;YACH,OAAOC;IACX;IAEA,IAAIK,SAAS;QACX,OAAOC,WAAWR,sBAAsBH;IAC1C;IAEA,IAAIa,YAAY;QACd,OAAOd;IACT;IAEA,IAAIY,UAAU;QACZ,OAAOL;IACT;IAEA,OAAOD;AACT,EAAE"}
+{"version":3,"sources":["../../src/menu/utils.ts"],"sourcesContent":["import type { FloatingActionButtonPosition } from \"../button/FloatingActionButton.js\";\nimport {\n  BELOW_CENTER_ANCHOR,\n  BELOW_INNER_LEFT_ANCHOR,\n  BOTTOM_INNER_LEFT_ANCHOR,\n  BOTTOM_INNER_RIGHT_ANCHOR,\n  CENTER_RIGHT_ANCHOR,\n  TOP_INNER_LEFT_ANCHOR,\n  TOP_INNER_RIGHT_ANCHOR,\n  TOP_RIGHT_ANCHOR,\n} from \"../positioning/constants.js\";\nimport type { PositionAnchor } from \"../positioning/types.js\";\n\n/**\n * @since 5.0.0\n * @internal\n */\ninterface DefaultAnchorOptions {\n  anchor?: PositionAnchor;\n  menubar: boolean;\n  menuitem: boolean;\n  floating?: FloatingActionButtonPosition;\n  horizontal: boolean;\n}\n\n/**\n * @since 5.0.0\n * @internal\n */\nexport const getDefaultAnchor = (\n  options: DefaultAnchorOptions\n): PositionAnchor => {\n  const { anchor, menubar, menuitem, floating, horizontal } = options;\n  if (anchor) {\n    return anchor;\n  }\n\n  switch (floating) {\n    case \"bottom-left\":\n      return BOTTOM_INNER_LEFT_ANCHOR;\n    case \"bottom-right\":\n      return BOTTOM_INNER_RIGHT_ANCHOR;\n    case \"top-left\":\n      return TOP_INNER_LEFT_ANCHOR;\n    case \"top-right\":\n      return TOP_INNER_RIGHT_ANCHOR;\n  }\n\n  if (menubar) {\n    return menuitem ? CENTER_RIGHT_ANCHOR : BELOW_INNER_LEFT_ANCHOR;\n  }\n\n  if (horizontal) {\n    return BELOW_CENTER_ANCHOR;\n  }\n\n  if (menuitem) {\n    return TOP_RIGHT_ANCHOR;\n  }\n\n  return TOP_INNER_RIGHT_ANCHOR;\n};\n"],"names":["BELOW_CENTER_ANCHOR","BELOW_INNER_LEFT_ANCHOR","BOTTOM_INNER_LEFT_ANCHOR","BOTTOM_INNER_RIGHT_ANCHOR","CENTER_RIGHT_ANCHOR","TOP_INNER_LEFT_ANCHOR","TOP_INNER_RIGHT_ANCHOR","TOP_RIGHT_ANCHOR","getDefaultAnchor","options","anchor","menubar","menuitem","floating","horizontal"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AACA,SACEA,mBAAmB,EACnBC,uBAAuB,EACvBC,wBAAwB,EACxBC,yBAAyB,EACzBC,mBAAmB,EACnBC,qBAAqB,EACrBC,sBAAsB,EACtBC,gBAAgB,QACX,8BAA8B;AAerC;;;CAGC,GACD,OAAO,MAAMC,mBAAmB,CAC9BC;IAEA,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,QAAQ,EAAEC,QAAQ,EAAEC,UAAU,EAAE,GAAGL;IAC5D,IAAIC,QAAQ;QACV,OAAOA;IACT;IAEA,OAAQG;QACN,KAAK;YACH,OAAOX;QACT,KAAK;YACH,OAAOC;QACT,KAAK;YACH,OAAOE;QACT,KAAK;YACH,OAAOC;IACX;IAEA,IAAIK,SAAS;QACX,OAAOC,WAAWR,sBAAsBH;IAC1C;IAEA,IAAIa,YAAY;QACd,OAAOd;IACT;IAEA,IAAIY,UAAU;QACZ,OAAOL;IACT;IAEA,OAAOD;AACT,EAAE"}

package/dist/movement/constants.d.ts

@@ -2,17 +2,17 @@ import type { KeyboardMovementConfig } from "./types.js";
 /**
  * Most custom keyboard functionality use these keys.
  *
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */
 export declare const DEFAULT_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig>;
 /**
- * @remarks \@since 5.1.2
+ * @since 5.1.2
  * @internal
  */
 export declare const DEFAULT_LTR_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig>;
 /**
- * @remarks \@since 5.1.2
+ * @since 5.1.2
  * @internal
  */
 export declare const DEFAULT_RTL_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig>;

package/dist/movement/constants.js

@@ -1,7 +1,7 @@
 /**
  * Most custom keyboard functionality use these keys.
  *
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  * @internal
  */ export const DEFAULT_KEYBOARD_MOVEMENT = {
     incrementKeys: [
@@ -18,7 +18,7 @@
     ]
 };
 /**
- * @remarks \@since 5.1.2
+ * @since 5.1.2
  * @internal
  */ export const DEFAULT_LTR_KEYBOARD_MOVEMENT = {
     incrementKeys: [
@@ -35,7 +35,7 @@
     ]
 };
 /**
- * @remarks \@since 5.1.2
+ * @since 5.1.2
  * @internal
  */ export const DEFAULT_RTL_KEYBOARD_MOVEMENT = {
     incrementKeys: [

package/dist/movement/constants.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/movement/constants.ts"],"sourcesContent":["import type { KeyboardMovementConfig } from \"./types.js\";\n\n/**\n * Most custom keyboard functionality use these keys.\n *\n * @remarks \\@since 5.0.0\n * @internal\n */\nexport const DEFAULT_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowDown\"],\n  decrementKeys: [\"ArrowUp\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n\n/**\n * @remarks \\@since 5.1.2\n * @internal\n */\nexport const DEFAULT_LTR_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowRight\"],\n  decrementKeys: [\"ArrowLeft\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n\n/**\n * @remarks \\@since 5.1.2\n * @internal\n */\nexport const DEFAULT_RTL_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowLeft\"],\n  decrementKeys: [\"ArrowRight\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n"],"names":["DEFAULT_KEYBOARD_MOVEMENT","incrementKeys","decrementKeys","jumpToFirstKeys","jumpToLastKeys","DEFAULT_LTR_KEYBOARD_MOVEMENT","DEFAULT_RTL_KEYBOARD_MOVEMENT"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAEA;;;;;CAKC,GACD,OAAO,MAAMA,4BAA8D;IACzEC,eAAe;QAAC;KAAY;IAC5BC,eAAe;QAAC;KAAU;IAC1BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,gCAAkE;IAC7EJ,eAAe;QAAC;KAAa;IAC7BC,eAAe;QAAC;KAAY;IAC5BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAME,gCAAkE;IAC7EL,eAAe;QAAC;KAAY;IAC5BC,eAAe;QAAC;KAAa;IAC7BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE"}
+{"version":3,"sources":["../../src/movement/constants.ts"],"sourcesContent":["import type { KeyboardMovementConfig } from \"./types.js\";\n\n/**\n * Most custom keyboard functionality use these keys.\n *\n * @since 5.0.0\n * @internal\n */\nexport const DEFAULT_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowDown\"],\n  decrementKeys: [\"ArrowUp\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n\n/**\n * @since 5.1.2\n * @internal\n */\nexport const DEFAULT_LTR_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowRight\"],\n  decrementKeys: [\"ArrowLeft\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n\n/**\n * @since 5.1.2\n * @internal\n */\nexport const DEFAULT_RTL_KEYBOARD_MOVEMENT: Readonly<KeyboardMovementConfig> = {\n  incrementKeys: [\"ArrowLeft\"],\n  decrementKeys: [\"ArrowRight\"],\n  jumpToFirstKeys: [\"Home\"],\n  jumpToLastKeys: [\"End\"],\n};\n"],"names":["DEFAULT_KEYBOARD_MOVEMENT","incrementKeys","decrementKeys","jumpToFirstKeys","jumpToLastKeys","DEFAULT_LTR_KEYBOARD_MOVEMENT","DEFAULT_RTL_KEYBOARD_MOVEMENT"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAEA;;;;;CAKC,GACD,OAAO,MAAMA,4BAA8D;IACzEC,eAAe;QAAC;KAAY;IAC5BC,eAAe;QAAC;KAAU;IAC1BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMC,gCAAkE;IAC7EJ,eAAe;QAAC;KAAa;IAC7BC,eAAe;QAAC;KAAY;IAC5BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAME,gCAAkE;IAC7EL,eAAe;QAAC;KAAY;IAC5BC,eAAe;QAAC;KAAa;IAC7BC,iBAAiB;QAAC;KAAO;IACzBC,gBAAgB;QAAC;KAAM;AACzB,EAAE"}

package/dist/movement/types.d.ts

@@ -14,7 +14,7 @@ import type { NonNullMutableRef, NonNullRef, UseStateSetter } from "../types.js"
  * - the container element specifies an `aria-activedescendant` pointing to one
  *   of the ids for the child "focusable" elements
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type TabIndexBehavior = "roving" | "virtual";
 /**
@@ -35,7 +35,7 @@ export type TabIndexBehavior = "roving" | "virtual";
  */
 export type GetFocusableElements = (container: HTMLElement, programmatic: boolean) => readonly HTMLElement[];
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */
 export interface KeyboardMovementConfiguration {
     /**
@@ -67,11 +67,11 @@ export interface KeyboardMovementConfiguration {
  * The defined {@link KeyboardMovementConfiguration} that should be used for
  * custom keyboard focus behavior.
  *
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */
 export type KeyboardMovementConfig = Required<KeyboardMovementConfiguration>;
 /**
- * @remarks \@since 5.0.0
+ * @since 5.0.0
  */
 export interface KeyboardMovementBehavior {
     /**
@@ -104,15 +104,14 @@ export interface KeyboardMovementBehavior {
      * updates the default keyboard config to use `ArrowRight` and `ArrowLeft`
      * instead of `ArrowDown` and `ArrowUp`,
      *
-     * @remarks \@since 5.1.2
+     * @since 5.1.2
      * @defaultValue `false`
      */
     horizontal?: boolean;
 }
 /**
- * @remarks
- * \@since 5.0.0
- * \@since 6.0.0 Removed `attach`, `detach` and `watching`
+ * @since 5.0.0
+ * @since 6.0.0 Removed `attach`, `detach` and `watching`
  * @internal
  */
 export interface KeyboardMovementContext extends Required<KeyboardMovementBehavior> {
@@ -127,7 +126,7 @@ export interface KeyboardMovementContext extends Required<KeyboardMovementBehavi
     activeDescendantId: string;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface FocusableIndexOptions {
@@ -135,17 +134,17 @@ export interface FocusableIndexOptions {
     includeDisabled: boolean;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export type GetDefaultFocusedIndex = (options: FocusableIndexOptions) => number;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export type ExtendKeyDown<E extends HTMLElement> = (movementData: KeyboardMovementExtensionData<E>) => void;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface KeyboardMovementFocusChangeEvent {
@@ -153,12 +152,12 @@ export interface KeyboardMovementFocusChangeEvent {
     element: HTMLElement;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export type KeyboardMovementFocusChangeEventHandler = (event: KeyboardMovementFocusChangeEvent) => void;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface KeyboardMovementExtensionData<E extends HTMLElement> extends KeyboardMovementContext {
@@ -168,7 +167,7 @@ export interface KeyboardMovementExtensionData<E extends HTMLElement> extends Ke
     setActiveDescendantId(id: string): void;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface KeyboardMovementProviderOptions<E extends HTMLElement> extends KeyboardMovementBehavior, KeyboardMovementConfiguration {
@@ -213,7 +212,7 @@ export interface KeyboardMovementProviderOptions<E extends HTMLElement> extends
     isNegativeOneAllowed?: boolean;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface KeyboardMovementProps<E extends HTMLElement> {
@@ -237,7 +236,7 @@ export interface KeyboardMovementProps<E extends HTMLElement> {
     onKeyDown: KeyboardEventHandler<E>;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface KeyboardMovementProviderImplementation<E extends HTMLElement> {

package/dist/movement/types.js

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export { };
 

package/dist/movement/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/movement/types.ts"],"sourcesContent":["import type {\n  FocusEvent,\n  FocusEventHandler,\n  KeyboardEvent,\n  KeyboardEventHandler,\n  MouseEvent,\n  MouseEventHandler,\n} from \"react\";\nimport type {\n  NonNullMutableRef,\n  NonNullRef,\n  UseStateSetter,\n} from \"../types.js\";\n\n/**\n * Set this to `\"roving\"` when:\n * - there are a group of focusable elements that have a `tabIndex={-1}`\n * - the container element defaults to having a `tabIndex={0}`\n * - if the container is focused, it should no longer be included in the normal\n *   tab flow. Instead, the current focused element should be included instead\n *   by changing its `tabIndex` from `-1` to `0`\n *\n * Set this to `\"virtual\"` when:\n * - the container element should never lose focus\n * - the \"focused\" element only gains focus styles instead of being focused\n * - the container element specifies an `aria-activedescendant` pointing to one\n *   of the ids for the child \"focusable\" elements\n *\n * @remarks \\@since 6.0.0\n */\nexport type TabIndexBehavior = \"roving\" | \"virtual\";\n\n/**\n * This should be used for specific widgets that should not include all\n * focusable elements and instead only specific elements.\n *\n * @example\n * ```ts\n * const getExpansionPanelsOnly: GetFocusableElements = (container) =>\n *   [...container.querySelectorAll(\".rmd-expansion-panel__button\")];\n *\n * const getTreeItemsOnly: GetFocusableElements = (container) =>\n *   [...container.querySelectorAll(\"[role='treeitem']\")];\n * ```\n *\n * @defaultValue `getFocusableElements`\n * @see the default `getFocusableElements` function.\n */\nexport type GetFocusableElements = (\n  container: HTMLElement,\n  programmatic: boolean\n) => readonly HTMLElement[];\n\n/**\n * @remarks \\@since 5.0.0\n */\nexport interface KeyboardMovementConfiguration {\n  /**\n   * A list of keys that will attempt to increment the focus index by 1.\n   *\n   * @defaultValue `[\"ArrowDown\"]`\n   */\n  incrementKeys?: readonly string[];\n\n  /**\n   * A list of keys that will attempt to decrement the focus index by 1.\n   *\n   * @defaultValue `[\"ArrowUp\"]`\n   */\n  decrementKeys?: readonly string[];\n\n  /**\n   * A list of keys that will set the focus index to `0`.\n   *\n   * @defaultValue `[\"Home\"]`\n   */\n  jumpToFirstKeys?: readonly string[];\n\n  /**\n   * A list of keys that will set the focus index to the last focusable index.\n   *\n   * @defaultValue `[\"End\"]`\n   */\n  jumpToLastKeys?: readonly string[];\n}\n\n/**\n * The defined {@link KeyboardMovementConfiguration} that should be used for\n * custom keyboard focus behavior.\n *\n * @remarks \\@since 5.0.0\n */\nexport type KeyboardMovementConfig = Required<KeyboardMovementConfiguration>;\n\n/**\n * @remarks \\@since 5.0.0\n */\nexport interface KeyboardMovementBehavior {\n  /**\n   * Boolean if pressing a letter will focus the next item in the\n   * {@link KeyboardMovementProvider} that starts with the same letter.\n   *\n   * @defaultValue `false`\n   */\n  searchable?: boolean;\n\n  /**\n   * Boolean if the {@link KeyboardMovementProvider} should allow the focus behavior\n   * to loop from the first to last or last to first item instead of preventing\n   * any new focus behavior. In other words... if the last item is focused and\n   * the user presses a key that should advance the focus to the next focusable\n   * element, should the focus stay on the current element or loop back and\n   * focus the first focusable item.\n   *\n   * @defaultValue `false`\n   */\n  loopable?: boolean;\n\n  /**\n   * Boolean if elements that are `aria-disabled` or `disabled` should still be\n   * able to gain focus.\n   *\n   * @defaultValue `false`\n   */\n  includeDisabled?: boolean;\n\n  /**\n   * Boolean if the keyboard movement is horizontal instead of vertical. This\n   * updates the default keyboard config to use `ArrowRight` and `ArrowLeft`\n   * instead of `ArrowDown` and `ArrowUp`,\n   *\n   * @remarks \\@since 5.1.2\n   * @defaultValue `false`\n   */\n  horizontal?: boolean;\n}\n\n/**\n * @remarks\n * \\@since 5.0.0\n * \\@since 6.0.0 Removed `attach`, `detach` and `watching`\n * @internal\n */\nexport interface KeyboardMovementContext\n  extends Required<KeyboardMovementBehavior> {\n  /** {@inheritDoc KeyboardMovementConfig} */\n  config: NonNullRef<KeyboardMovementConfig>;\n\n  /** @see {@link TabIndexBehavior} */\n  tabIndexBehavior: TabIndexBehavior | undefined;\n\n  /**\n   * Note: This will only update if the {@link KeyboardMovementProviderOptions.tabIndexBehavior}\n   * has been set to `\"roving\"` or `\"virtual\"`.\n   */\n  activeDescendantId: string;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface FocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport type GetDefaultFocusedIndex = (options: FocusableIndexOptions) => number;\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport type ExtendKeyDown<E extends HTMLElement> = (\n  movementData: KeyboardMovementExtensionData<E>\n) => void;\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementFocusChangeEvent {\n  index: number;\n  element: HTMLElement;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport type KeyboardMovementFocusChangeEventHandler = (\n  event: KeyboardMovementFocusChangeEvent\n) => void;\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementExtensionData<E extends HTMLElement>\n  extends KeyboardMovementContext {\n  event: KeyboardEvent<E>;\n  currentFocusIndex: NonNullMutableRef<number>;\n  setFocusIndex(index: number, focusables: readonly HTMLElement[]): void;\n  setActiveDescendantId(id: string): void;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProviderOptions<E extends HTMLElement>\n  extends KeyboardMovementBehavior,\n    KeyboardMovementConfiguration {\n  /** @see {@link TabIndexBehavior} */\n  tabIndexBehavior?: TabIndexBehavior;\n\n  onClick?(event: MouseEvent<E>): void;\n  onFocus?(event: FocusEvent<E>): void;\n  onKeyDown?(event: KeyboardEvent<E>): void;\n\n  /** @defaultValue `false` */\n  disabled?: boolean;\n\n  /**\n   * This is used to implement custom keyboard movement for the `keydown` event.\n   */\n  extendKeyDown?: ExtendKeyDown<E>;\n\n  /**\n   * Triggered whenever the focus changes.\n   */\n  onFocusChange?: KeyboardMovementFocusChangeEventHandler;\n\n  /**\n   * From what I've understood so far, programmatically focusable elements\n   * should only be included when disabled elements via `aria-disabled` are\n   * allowed.\n   *\n   * @defaultValue `includeDisabled`\n   */\n  programmatic?: boolean;\n\n  /** @see {@link GetFocusableElements} */\n  getFocusableElements?: GetFocusableElements;\n\n  /**\n   * This can be used to set the initial focus index whenever the container\n   * element is first focused or the focus index is `-1` on other focus events.\n   */\n  getDefaultFocusedIndex?: GetDefaultFocusedIndex;\n\n  /**\n   * This was added to support editable combobox behavior. As the user types or\n   * uses native input keyboard behavior, the focus index should be reset to\n   * `-1` so that the next \"ArrowDown\" event focuses the first option again\n   * instead of the last selected one.\n   *\n   * @defaultValue `false`\n   */\n  isNegativeOneAllowed?: boolean;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProps<E extends HTMLElement> {\n  /**\n   * This will only be provided if the {@link KeyboardMovementContext.tabIndexBehavior}\n   * is set to `\"virtual\"`.\n   */\n  \"aria-activedescendant\"?: string;\n\n  /**\n   * This will not be provided if the {@link KeyboardMovementContext.tabIndexBehavior}\n   * is `undefined`. Otherwise:\n   * - `0` when `\"virtual\"`\n   * - `0` when `\"roving\"` and the container element has not been focused at\n   *   least once\n   * - `-1` when `\"roving\"` and the container has been focused at least once\n   *   - a child element **should** have a `tabIndex={0}` instead\n   */\n  tabIndex?: number;\n  onClick: MouseEventHandler<E>;\n  onFocus: FocusEventHandler<E>;\n  onKeyDown: KeyboardEventHandler<E>;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProviderImplementation<E extends HTMLElement> {\n  movementProps: Readonly<KeyboardMovementProps<E>>;\n  movementContext: Readonly<KeyboardMovementContext>;\n  currentFocusIndex: NonNullMutableRef<number>;\n  activeDescendantId: string;\n  setActiveDescendantId: UseStateSetter<string>;\n}\n"],"names":[],"rangeMappings":";;;","mappings":"AAoSA;;;CAGC,GACD,WAMC"}
+{"version":3,"sources":["../../src/movement/types.ts"],"sourcesContent":["import type {\n  FocusEvent,\n  FocusEventHandler,\n  KeyboardEvent,\n  KeyboardEventHandler,\n  MouseEvent,\n  MouseEventHandler,\n} from \"react\";\nimport type {\n  NonNullMutableRef,\n  NonNullRef,\n  UseStateSetter,\n} from \"../types.js\";\n\n/**\n * Set this to `\"roving\"` when:\n * - there are a group of focusable elements that have a `tabIndex={-1}`\n * - the container element defaults to having a `tabIndex={0}`\n * - if the container is focused, it should no longer be included in the normal\n *   tab flow. Instead, the current focused element should be included instead\n *   by changing its `tabIndex` from `-1` to `0`\n *\n * Set this to `\"virtual\"` when:\n * - the container element should never lose focus\n * - the \"focused\" element only gains focus styles instead of being focused\n * - the container element specifies an `aria-activedescendant` pointing to one\n *   of the ids for the child \"focusable\" elements\n *\n * @since 6.0.0\n */\nexport type TabIndexBehavior = \"roving\" | \"virtual\";\n\n/**\n * This should be used for specific widgets that should not include all\n * focusable elements and instead only specific elements.\n *\n * @example\n * ```ts\n * const getExpansionPanelsOnly: GetFocusableElements = (container) =>\n *   [...container.querySelectorAll(\".rmd-expansion-panel__button\")];\n *\n * const getTreeItemsOnly: GetFocusableElements = (container) =>\n *   [...container.querySelectorAll(\"[role='treeitem']\")];\n * ```\n *\n * @defaultValue `getFocusableElements`\n * @see the default `getFocusableElements` function.\n */\nexport type GetFocusableElements = (\n  container: HTMLElement,\n  programmatic: boolean\n) => readonly HTMLElement[];\n\n/**\n * @since 5.0.0\n */\nexport interface KeyboardMovementConfiguration {\n  /**\n   * A list of keys that will attempt to increment the focus index by 1.\n   *\n   * @defaultValue `[\"ArrowDown\"]`\n   */\n  incrementKeys?: readonly string[];\n\n  /**\n   * A list of keys that will attempt to decrement the focus index by 1.\n   *\n   * @defaultValue `[\"ArrowUp\"]`\n   */\n  decrementKeys?: readonly string[];\n\n  /**\n   * A list of keys that will set the focus index to `0`.\n   *\n   * @defaultValue `[\"Home\"]`\n   */\n  jumpToFirstKeys?: readonly string[];\n\n  /**\n   * A list of keys that will set the focus index to the last focusable index.\n   *\n   * @defaultValue `[\"End\"]`\n   */\n  jumpToLastKeys?: readonly string[];\n}\n\n/**\n * The defined {@link KeyboardMovementConfiguration} that should be used for\n * custom keyboard focus behavior.\n *\n * @since 5.0.0\n */\nexport type KeyboardMovementConfig = Required<KeyboardMovementConfiguration>;\n\n/**\n * @since 5.0.0\n */\nexport interface KeyboardMovementBehavior {\n  /**\n   * Boolean if pressing a letter will focus the next item in the\n   * {@link KeyboardMovementProvider} that starts with the same letter.\n   *\n   * @defaultValue `false`\n   */\n  searchable?: boolean;\n\n  /**\n   * Boolean if the {@link KeyboardMovementProvider} should allow the focus behavior\n   * to loop from the first to last or last to first item instead of preventing\n   * any new focus behavior. In other words... if the last item is focused and\n   * the user presses a key that should advance the focus to the next focusable\n   * element, should the focus stay on the current element or loop back and\n   * focus the first focusable item.\n   *\n   * @defaultValue `false`\n   */\n  loopable?: boolean;\n\n  /**\n   * Boolean if elements that are `aria-disabled` or `disabled` should still be\n   * able to gain focus.\n   *\n   * @defaultValue `false`\n   */\n  includeDisabled?: boolean;\n\n  /**\n   * Boolean if the keyboard movement is horizontal instead of vertical. This\n   * updates the default keyboard config to use `ArrowRight` and `ArrowLeft`\n   * instead of `ArrowDown` and `ArrowUp`,\n   *\n   * @since 5.1.2\n   * @defaultValue `false`\n   */\n  horizontal?: boolean;\n}\n\n/**\n * @since 5.0.0\n * @since 6.0.0 Removed `attach`, `detach` and `watching`\n * @internal\n */\nexport interface KeyboardMovementContext\n  extends Required<KeyboardMovementBehavior> {\n  /** {@inheritDoc KeyboardMovementConfig} */\n  config: NonNullRef<KeyboardMovementConfig>;\n\n  /** @see {@link TabIndexBehavior} */\n  tabIndexBehavior: TabIndexBehavior | undefined;\n\n  /**\n   * Note: This will only update if the {@link KeyboardMovementProviderOptions.tabIndexBehavior}\n   * has been set to `\"roving\"` or `\"virtual\"`.\n   */\n  activeDescendantId: string;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface FocusableIndexOptions {\n  focusables: readonly HTMLElement[];\n  includeDisabled: boolean;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport type GetDefaultFocusedIndex = (options: FocusableIndexOptions) => number;\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport type ExtendKeyDown<E extends HTMLElement> = (\n  movementData: KeyboardMovementExtensionData<E>\n) => void;\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementFocusChangeEvent {\n  index: number;\n  element: HTMLElement;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport type KeyboardMovementFocusChangeEventHandler = (\n  event: KeyboardMovementFocusChangeEvent\n) => void;\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementExtensionData<E extends HTMLElement>\n  extends KeyboardMovementContext {\n  event: KeyboardEvent<E>;\n  currentFocusIndex: NonNullMutableRef<number>;\n  setFocusIndex(index: number, focusables: readonly HTMLElement[]): void;\n  setActiveDescendantId(id: string): void;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProviderOptions<E extends HTMLElement>\n  extends KeyboardMovementBehavior,\n    KeyboardMovementConfiguration {\n  /** @see {@link TabIndexBehavior} */\n  tabIndexBehavior?: TabIndexBehavior;\n\n  onClick?(event: MouseEvent<E>): void;\n  onFocus?(event: FocusEvent<E>): void;\n  onKeyDown?(event: KeyboardEvent<E>): void;\n\n  /** @defaultValue `false` */\n  disabled?: boolean;\n\n  /**\n   * This is used to implement custom keyboard movement for the `keydown` event.\n   */\n  extendKeyDown?: ExtendKeyDown<E>;\n\n  /**\n   * Triggered whenever the focus changes.\n   */\n  onFocusChange?: KeyboardMovementFocusChangeEventHandler;\n\n  /**\n   * From what I've understood so far, programmatically focusable elements\n   * should only be included when disabled elements via `aria-disabled` are\n   * allowed.\n   *\n   * @defaultValue `includeDisabled`\n   */\n  programmatic?: boolean;\n\n  /** @see {@link GetFocusableElements} */\n  getFocusableElements?: GetFocusableElements;\n\n  /**\n   * This can be used to set the initial focus index whenever the container\n   * element is first focused or the focus index is `-1` on other focus events.\n   */\n  getDefaultFocusedIndex?: GetDefaultFocusedIndex;\n\n  /**\n   * This was added to support editable combobox behavior. As the user types or\n   * uses native input keyboard behavior, the focus index should be reset to\n   * `-1` so that the next \"ArrowDown\" event focuses the first option again\n   * instead of the last selected one.\n   *\n   * @defaultValue `false`\n   */\n  isNegativeOneAllowed?: boolean;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProps<E extends HTMLElement> {\n  /**\n   * This will only be provided if the {@link KeyboardMovementContext.tabIndexBehavior}\n   * is set to `\"virtual\"`.\n   */\n  \"aria-activedescendant\"?: string;\n\n  /**\n   * This will not be provided if the {@link KeyboardMovementContext.tabIndexBehavior}\n   * is `undefined`. Otherwise:\n   * - `0` when `\"virtual\"`\n   * - `0` when `\"roving\"` and the container element has not been focused at\n   *   least once\n   * - `-1` when `\"roving\"` and the container has been focused at least once\n   *   - a child element **should** have a `tabIndex={0}` instead\n   */\n  tabIndex?: number;\n  onClick: MouseEventHandler<E>;\n  onFocus: FocusEventHandler<E>;\n  onKeyDown: KeyboardEventHandler<E>;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface KeyboardMovementProviderImplementation<E extends HTMLElement> {\n  movementProps: Readonly<KeyboardMovementProps<E>>;\n  movementContext: Readonly<KeyboardMovementContext>;\n  currentFocusIndex: NonNullMutableRef<number>;\n  activeDescendantId: string;\n  setActiveDescendantId: UseStateSetter<string>;\n}\n"],"names":[],"rangeMappings":";;;","mappings":"AAmSA;;;CAGC,GACD,WAMC"}

package/dist/movement/useKeyboardMovementProvider.d.ts

@@ -2,7 +2,7 @@
 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,8 +10,7 @@ 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,
@@ -34,8 +33,7 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  * }
  * ```
  *
- * @example
- * Active Descendant Movement
+ * @example Active Descendant Movement
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
@@ -81,8 +79,7 @@ export declare function useKeyboardMovementContext(): Readonly<KeyboardMovementC
  * }
  * ```
  *
- * @example
- * Roving Tab Index
+ * @example Roving Tab Index
  * ```tsx
  * import {
  *   KeyboardMovementProvider,
@@ -127,7 +124,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>;