@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/menu/menu-item-check.d.ts

@@ -12,12 +12,18 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItemCheck: import("../utils/types.js").Hook<MenuItemCheckOptions<"span">>;
 /**
- * Renders a checkmark inside a `MenuItemCheckbox` or `MenuItemRadio`
- * components. This component must be wrapped with one of those components or
- * the `checked` prop must be explicitly passed to the component.
+ * Renders a checkmark icon when the
+ * [`checked`](https://ariakit.org/reference/menu-item-check#checked) prop is
+ * `true`. The icon can be overridden by providing a different one as children.
+ *
+ * When rendered inside
+ * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox) or
+ * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio) components,
+ * the [`checked`](https://ariakit.org/reference/menu-item-check#checked) prop
+ * is automatically derived from the context.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {5,9}
  * <MenuProvider defaultValues={{ apple: true, orange: false }}>
  *   <MenuButton>Fruits</MenuButton>
  *   <Menu>
@@ -40,19 +46,5 @@ export interface MenuItemCheckOptions<T extends As = "span"> extends Omit<Checkb
      * [`useMenuStore`](https://ariakit.org/reference/use-menu-store) hook.
      */
     store?: MenuStore;
-    /**
-     * Determines if the check mark should be displayed. This value is automatically
-     * derived from the parent
-     * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio) or
-     * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox)
-     * component.
-     *
-     * Manually setting this prop will supersede the derived value.
-     *
-     * Live examples:
-     * - [Submenu with
-     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
-     */
-    checked?: CheckboxCheckOptions<T>["checked"];
 }
 export type MenuItemCheckProps<T extends As = "span"> = Props<MenuItemCheckOptions<T>>;

package/cjs/menu/menu-item-checkbox.cjs

@@ -1,11 +1,11 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _BBS4RP44cjs = require('../__chunks/BBS4RP44.cjs');
-require('../__chunks/63UPRTFZ.cjs');
+var _VPQQSYH7cjs = require('../__chunks/VPQQSYH7.cjs');
 
 
-var _VPQQSYH7cjs = require('../__chunks/VPQQSYH7.cjs');
+var _BBS4RP44cjs = require('../__chunks/BBS4RP44.cjs');
+require('../__chunks/63UPRTFZ.cjs');
 
 
 var _NNINKJTTcjs = require('../__chunks/NNINKJTT.cjs');

package/cjs/menu/menu-item-checkbox.d.cts

@@ -17,14 +17,43 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItemCheckbox: import("../utils/types.js").Hook<MenuItemCheckboxOptions<"div">>;
 /**
- * Renders a menu item checkbox inside a menu.
+ * Renders a [`menuitemcheckbox`](https://w3c.github.io/aria/#menuitemcheckbox)
+ * element within a [`Menu`](https://ariakit.org/reference/menu) component. The
+ * [`name`](https://ariakit.org/reference/menu-item-checkbox#name) prop must be
+ * provided to identify the field in the
+ * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+ *
+ * A [`MenuItemCheck`](https://ariakit.org/reference/menu-item-check) can be
+ * used to render a checkmark inside this component.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider defaultValues={{ apple: false }}>
- *   <MenuButton>Fruits</MenuButton>
+ * The [`name`](https://ariakit.org/reference/menu-item-checkbox#name) prop can
+ * refer to a single value in the state:
+ * ```jsx {4-7}
+ * <MenuProvider defaultValues={{ warnBeforeQuitting: true }}>
+ *   <MenuButton>Chrome</MenuButton>
+ *   <Menu>
+ *     <MenuItemCheckbox name="warnBeforeQuitting">
+ *       <MenuItemCheck />
+ *       Warn Before Quitting
+ *     </MenuItemCheckbox>
+ *   </Menu>
+ * </MenuProvider>
+ * ```
+ * @example
+ * Or it can refer to an array of values, in which case the
+ * [`value`](https://ariakit.org/reference/menu-item-checkbox#value) prop must
+ * be provided:
+ * ```jsx {4-9}
+ * <MenuProvider defaultValues={{ watching: ["issues"] }}>
+ *   <MenuButton>Watch</MenuButton>
  *   <Menu>
- *     <MenuItemCheckbox name="apple">Apple</MenuItemCheckbox>
+ *     <MenuItemCheckbox name="watching" value="issues">
+ *       Issues
+ *     </MenuItemCheckbox>
+ *     <MenuItemCheckbox name="watching" value="pull-requests">
+ *       Pull Requests
+ *     </MenuItemCheckbox>
  *   </Menu>
  * </MenuProvider>
  * ```
@@ -40,8 +69,11 @@ export interface MenuItemCheckboxOptions<T extends As = "div"> extends MenuItemO
      */
     store?: MenuStore;
     /**
-     * MenuItemCheckbox's name as specified in the
+     * The name of the field in the
      * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      */
     name: string;
     /**

package/cjs/menu/menu-item-checkbox.d.ts

@@ -17,14 +17,43 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItemCheckbox: import("../utils/types.js").Hook<MenuItemCheckboxOptions<"div">>;
 /**
- * Renders a menu item checkbox inside a menu.
+ * Renders a [`menuitemcheckbox`](https://w3c.github.io/aria/#menuitemcheckbox)
+ * element within a [`Menu`](https://ariakit.org/reference/menu) component. The
+ * [`name`](https://ariakit.org/reference/menu-item-checkbox#name) prop must be
+ * provided to identify the field in the
+ * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+ *
+ * A [`MenuItemCheck`](https://ariakit.org/reference/menu-item-check) can be
+ * used to render a checkmark inside this component.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider defaultValues={{ apple: false }}>
- *   <MenuButton>Fruits</MenuButton>
+ * The [`name`](https://ariakit.org/reference/menu-item-checkbox#name) prop can
+ * refer to a single value in the state:
+ * ```jsx {4-7}
+ * <MenuProvider defaultValues={{ warnBeforeQuitting: true }}>
+ *   <MenuButton>Chrome</MenuButton>
+ *   <Menu>
+ *     <MenuItemCheckbox name="warnBeforeQuitting">
+ *       <MenuItemCheck />
+ *       Warn Before Quitting
+ *     </MenuItemCheckbox>
+ *   </Menu>
+ * </MenuProvider>
+ * ```
+ * @example
+ * Or it can refer to an array of values, in which case the
+ * [`value`](https://ariakit.org/reference/menu-item-checkbox#value) prop must
+ * be provided:
+ * ```jsx {4-9}
+ * <MenuProvider defaultValues={{ watching: ["issues"] }}>
+ *   <MenuButton>Watch</MenuButton>
  *   <Menu>
- *     <MenuItemCheckbox name="apple">Apple</MenuItemCheckbox>
+ *     <MenuItemCheckbox name="watching" value="issues">
+ *       Issues
+ *     </MenuItemCheckbox>
+ *     <MenuItemCheckbox name="watching" value="pull-requests">
+ *       Pull Requests
+ *     </MenuItemCheckbox>
  *   </Menu>
  * </MenuProvider>
  * ```
@@ -40,8 +69,11 @@ export interface MenuItemCheckboxOptions<T extends As = "div"> extends MenuItemO
      */
     store?: MenuStore;
     /**
-     * MenuItemCheckbox's name as specified in the
+     * The name of the field in the
      * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      */
     name: string;
     /**

package/cjs/menu/menu-item-radio.d.cts

@@ -19,18 +19,27 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItemRadio: import("../utils/types.js").Hook<MenuItemRadioOptions<"div">>;
 /**
- * Renders a menu item radio inside a menu.
+ * Renders a [`menuitemradio`](https://w3c.github.io/aria/#menuitemradio)
+ * element within a [`Menu`](https://ariakit.org/reference/menu) component. The
+ * [`name`](https://ariakit.org/reference/menu-item-radio#name) prop must be
+ * provided to identify the field in the
+ * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+ *
+ * A [`MenuItemCheck`](https://ariakit.org/reference/menu-item-check) can be
+ * used to render a checkmark inside this component.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider defaultValues={{ fruit: "apple" }}>
- *   <MenuButton>Fruit</MenuButton>
+ * ```jsx {4-11}
+ * <MenuProvider defaultValues={{ profile: "john" }}>
+ *   <MenuButton>Profiles</MenuButton>
  *   <Menu>
- *     <MenuItemRadio name="fruit" value="apple">
- *       Apple
+ *     <MenuItemRadio name="profile" value="john">
+ *       <MenuItemCheck />
+ *       John Doe
  *     </MenuItemRadio>
- *     <MenuItemRadio name="fruit" value="orange">
- *       Orange
+ *     <MenuItemRadio name="profile" value="jane">
+ *       <MenuItemCheck />
+ *       Jane Doe
  *     </MenuItemRadio>
  *   </Menu>
  * </MenuProvider>
@@ -47,8 +56,11 @@ export interface MenuItemRadioOptions<T extends As = "div"> extends MenuItemOpti
      */
     store?: MenuStore;
     /**
-     * MenuItemRadio's name as specified in the
+     * The name of the field in the
      * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      */
     name: string;
     /**

package/cjs/menu/menu-item-radio.d.ts

@@ -19,18 +19,27 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItemRadio: import("../utils/types.js").Hook<MenuItemRadioOptions<"div">>;
 /**
- * Renders a menu item radio inside a menu.
+ * Renders a [`menuitemradio`](https://w3c.github.io/aria/#menuitemradio)
+ * element within a [`Menu`](https://ariakit.org/reference/menu) component. The
+ * [`name`](https://ariakit.org/reference/menu-item-radio#name) prop must be
+ * provided to identify the field in the
+ * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+ *
+ * A [`MenuItemCheck`](https://ariakit.org/reference/menu-item-check) can be
+ * used to render a checkmark inside this component.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider defaultValues={{ fruit: "apple" }}>
- *   <MenuButton>Fruit</MenuButton>
+ * ```jsx {4-11}
+ * <MenuProvider defaultValues={{ profile: "john" }}>
+ *   <MenuButton>Profiles</MenuButton>
  *   <Menu>
- *     <MenuItemRadio name="fruit" value="apple">
- *       Apple
+ *     <MenuItemRadio name="profile" value="john">
+ *       <MenuItemCheck />
+ *       John Doe
  *     </MenuItemRadio>
- *     <MenuItemRadio name="fruit" value="orange">
- *       Orange
+ *     <MenuItemRadio name="profile" value="jane">
+ *       <MenuItemCheck />
+ *       Jane Doe
  *     </MenuItemRadio>
  *   </Menu>
  * </MenuProvider>
@@ -47,8 +56,11 @@ export interface MenuItemRadioOptions<T extends As = "div"> extends MenuItemOpti
      */
     store?: MenuStore;
     /**
-     * MenuItemRadio's name as specified in the
+     * The name of the field in the
      * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      */
     name: string;
     /**

package/cjs/menu/menu-item.d.cts

@@ -22,10 +22,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItem: import("../utils/types.js").Hook<MenuItemOptions<"div">>;
 /**
- * Renders a menu item.
+ * Renders a menu item inside
+ * [`MenuList`](https://ariakit.org/reference/menu-list) or
+ * [`Menu`](https://ariakit.org/reference/menu)
+ * components.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4-5}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>
@@ -50,20 +53,16 @@ export interface MenuItemOptions<T extends As = "div"> extends CompositeItemOpti
      */
     store?: MenubarStore | MenuStore;
     /**
-     * Whether to hide the menu when a menu item is clicked. This prop won't be
-     * invoked if the click is on a link and modifier keys are used to open the
-     * link in a new tab or download it.
+     * Determines if the menu should hide when this item is clicked.
+     *
+     * **Note**: This behavior isn't triggered if this menu item is rendered as a
+     * link and modifier keys are used to either open the link in a new tab or
+     * download it.
      *
      * Live examples:
-     * - [Submenu with
-     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      * @default true
      */
     hideOnClick?: BooleanOrCallback<MouseEvent<HTMLElement>>;
-    /**
-     * @default true
-     */
-    preventScrollOnKeyDown?: CompositeItemOptions<T>["preventScrollOnKeyDown"];
 }
 export type MenuItemProps<T extends As = "div"> = Props<MenuItemOptions<T>>;

package/cjs/menu/menu-item.d.ts

@@ -22,10 +22,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuItem: import("../utils/types.js").Hook<MenuItemOptions<"div">>;
 /**
- * Renders a menu item.
+ * Renders a menu item inside
+ * [`MenuList`](https://ariakit.org/reference/menu-list) or
+ * [`Menu`](https://ariakit.org/reference/menu)
+ * components.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4-5}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>
@@ -50,20 +53,16 @@ export interface MenuItemOptions<T extends As = "div"> extends CompositeItemOpti
      */
     store?: MenubarStore | MenuStore;
     /**
-     * Whether to hide the menu when a menu item is clicked. This prop won't be
-     * invoked if the click is on a link and modifier keys are used to open the
-     * link in a new tab or download it.
+     * Determines if the menu should hide when this item is clicked.
+     *
+     * **Note**: This behavior isn't triggered if this menu item is rendered as a
+     * link and modifier keys are used to either open the link in a new tab or
+     * download it.
      *
      * Live examples:
-     * - [Submenu with
-     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      * @default true
      */
     hideOnClick?: BooleanOrCallback<MouseEvent<HTMLElement>>;
-    /**
-     * @default true
-     */
-    preventScrollOnKeyDown?: CompositeItemOptions<T>["preventScrollOnKeyDown"];
 }
 export type MenuItemProps<T extends As = "div"> = Props<MenuItemOptions<T>>;

package/cjs/menu/menu-list.d.cts

@@ -19,10 +19,15 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuList: import("../utils/types.js").Hook<MenuListOptions<"div">>;
 /**
- * Renders a menu list element.
+ * Renders a menu list element. This is the primitive component used by the
+ * [`Menu`](https://ariakit.org/reference/menu) component.
+ *
+ * Unlike [`Menu`](https://ariakit.org/reference/menu), this component doesn't
+ * render a popover and therefore doesn't automatically focus on items when
+ * opened.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3-6}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <MenuList>

package/cjs/menu/menu-list.d.ts

@@ -19,10 +19,15 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuList: import("../utils/types.js").Hook<MenuListOptions<"div">>;
 /**
- * Renders a menu list element.
+ * Renders a menu list element. This is the primitive component used by the
+ * [`Menu`](https://ariakit.org/reference/menu) component.
+ *
+ * Unlike [`Menu`](https://ariakit.org/reference/menu), this component doesn't
+ * render a popover and therefore doesn't automatically focus on items when
+ * opened.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3-6}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <MenuList>

package/cjs/menu/menu-provider.d.cts

@@ -3,7 +3,8 @@ import type { PickRequired } from "@ariakit/core/utils/types";
 import type { MenuStoreProps, MenuStoreValues } from "./menu-store.js";
 type Values = MenuStoreValues;
 /**
- * Provides a menu store to Menu components.
+ * Provides a menu store to [Menu](https://ariakit.org/components/menu)
+ * components.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx

package/cjs/menu/menu-provider.d.ts

@@ -3,7 +3,8 @@ import type { PickRequired } from "@ariakit/core/utils/types";
 import type { MenuStoreProps, MenuStoreValues } from "./menu-store.js";
 type Values = MenuStoreValues;
 /**
- * Provides a menu store to Menu components.
+ * Provides a menu store to [Menu](https://ariakit.org/components/menu)
+ * components.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx

package/cjs/menu/menu-separator.d.cts

@@ -19,10 +19,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuSeparator: import("../utils/types.js").Hook<MenuSeparatorOptions<"hr">>;
 /**
- * Renders a separator for menu items.
+ * Renders a divider between
+ * [`MenuItem`](https://ariakit.org/reference/menu-item),
+ * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox), and
+ * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio) elements.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {6}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>

package/cjs/menu/menu-separator.d.ts

@@ -19,10 +19,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuSeparator: import("../utils/types.js").Hook<MenuSeparatorOptions<"hr">>;
 /**
- * Renders a separator for menu items.
+ * Renders a divider between
+ * [`MenuItem`](https://ariakit.org/reference/menu-item),
+ * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox), and
+ * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio) elements.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {6}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>

package/cjs/menu/menu-store.d.cts

@@ -11,11 +11,13 @@ export declare function useMenuStoreProps<T extends Core.MenuStore>(store: T, up
     menubar: MenubarStore | null | undefined;
 };
 /**
- * Creates a menu store.
+ * Creates a menu store to control the state of
+ * [Menu](https://ariakit.org/components/menu) components.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx
  * const menu = useMenuStore({ placement: "top" });
+ *
  * <MenuButton store={menu}>Edit</MenuButton>
  * <Menu store={menu}>
  *   <MenuItem>Undo</MenuItem>
@@ -32,7 +34,9 @@ export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues>
 }
 export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> extends Core.MenuStoreOptions<T>, CompositeStoreOptions, HovercardStoreOptions {
     /**
-     * A callback that gets called when the `values` state changes.
+     * A callback that gets called when the
+     * [`values`](https://ariakit.org/reference/menu-provider#values) state
+     * changes.
      *
      * Live examples:
      * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
@@ -41,9 +45,10 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      */
     setValues?: BivariantCallback<(values: MenuStoreState<T>["values"]) => void>;
     /**
-     * A reference to a combobox store. This is used when combining the combobox
-     * with a menu (e.g., dropdown menu with a search input). The stores will
-     * share the same state.
+     * A reference to a [combobox
+     * store](https://ariakit.org/reference/use-combobox-store). It's
+     * automatically set when composing [Menu with
+     * Combobox](https://ariakit.org/examples/menu-combobox).
      */
     combobox?: ComboboxStore | null;
     /**
@@ -54,11 +59,17 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      * Live examples:
      * - [Menubar](https://ariakit.org/components/menubar)
      * - [Submenu](https://ariakit.org/examples/menu-nested)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     parent?: MenuStore | null;
     /**
-     * A reference to a menu bar store. It's automatically set when rendering
-     * menus inside a menu bar in the React tree.
+     * A reference to a [menubar
+     * store](https://ariakit.org/reference/use-menubar-store). It's automatically
+     * set when rendering menus inside a
+     * [`Menubar`](https://ariakit.org/reference/menubar) in the React tree.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     menubar?: MenubarStore | null;
 }

package/cjs/menu/menu-store.d.ts

@@ -11,11 +11,13 @@ export declare function useMenuStoreProps<T extends Core.MenuStore>(store: T, up
     menubar: MenubarStore | null | undefined;
 };
 /**
- * Creates a menu store.
+ * Creates a menu store to control the state of
+ * [Menu](https://ariakit.org/components/menu) components.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx
  * const menu = useMenuStore({ placement: "top" });
+ *
  * <MenuButton store={menu}>Edit</MenuButton>
  * <Menu store={menu}>
  *   <MenuItem>Undo</MenuItem>
@@ -32,7 +34,9 @@ export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues>
 }
 export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> extends Core.MenuStoreOptions<T>, CompositeStoreOptions, HovercardStoreOptions {
     /**
-     * A callback that gets called when the `values` state changes.
+     * A callback that gets called when the
+     * [`values`](https://ariakit.org/reference/menu-provider#values) state
+     * changes.
      *
      * Live examples:
      * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
@@ -41,9 +45,10 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      */
     setValues?: BivariantCallback<(values: MenuStoreState<T>["values"]) => void>;
     /**
-     * A reference to a combobox store. This is used when combining the combobox
-     * with a menu (e.g., dropdown menu with a search input). The stores will
-     * share the same state.
+     * A reference to a [combobox
+     * store](https://ariakit.org/reference/use-combobox-store). It's
+     * automatically set when composing [Menu with
+     * Combobox](https://ariakit.org/examples/menu-combobox).
      */
     combobox?: ComboboxStore | null;
     /**
@@ -54,11 +59,17 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      * Live examples:
      * - [Menubar](https://ariakit.org/components/menubar)
      * - [Submenu](https://ariakit.org/examples/menu-nested)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     parent?: MenuStore | null;
     /**
-     * A reference to a menu bar store. It's automatically set when rendering
-     * menus inside a menu bar in the React tree.
+     * A reference to a [menubar
+     * store](https://ariakit.org/reference/use-menubar-store). It's automatically
+     * set when rendering menus inside a
+     * [`Menubar`](https://ariakit.org/reference/menubar) in the React tree.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     menubar?: MenubarStore | null;
 }

package/cjs/menu/menu.cjs

@@ -13,14 +13,14 @@ require('../__chunks/UZNYSPKP.cjs');
 require('../__chunks/BZTDJIVT.cjs');
 
 
-var _7HJPL3H2cjs = require('../__chunks/7HJPL3H2.cjs');
+var _I2KHXDVLcjs = require('../__chunks/I2KHXDVL.cjs');
 require('../__chunks/KXQOQQ5B.cjs');
-require('../__chunks/KDG57VZV.cjs');
+require('../__chunks/OUEE5HOS.cjs');
 
 
-var _EKB76T2Ucjs = require('../__chunks/EKB76T2U.cjs');
+var _ZL5DC555cjs = require('../__chunks/ZL5DC555.cjs');
 require('../__chunks/WZ3DRKGP.cjs');
-require('../__chunks/NKR65BKC.cjs');
+require('../__chunks/KSPMHEYZ.cjs');
 require('../__chunks/PZL34OVO.cjs');
 require('../__chunks/344F3DYO.cjs');
 require('../__chunks/KREY6HXD.cjs');
@@ -28,11 +28,11 @@ require('../__chunks/5ZOCN23X.cjs');
 require('../__chunks/JVDUGICD.cjs');
 require('../__chunks/VV6WA3I6.cjs');
 require('../__chunks/7YLCVXZ7.cjs');
+require('../__chunks/5GTNIPQ6.cjs');
 require('../__chunks/7TN63K2T.cjs');
+require('../__chunks/V24PR4PW.cjs');
 require('../__chunks/6IUEXB4L.cjs');
 require('../__chunks/JF225FQ5.cjs');
-require('../__chunks/5GTNIPQ6.cjs');
-require('../__chunks/V24PR4PW.cjs');
 require('../__chunks/7566TIRW.cjs');
 require('../__chunks/J3OG6T3B.cjs');
 require('../__chunks/65LGW5LY.cjs');
@@ -170,7 +170,7 @@ var useMenu = _RNZNGEL4cjs.createHook.call(void 0,
         preserveTabOrderAnchor
       }, props);
     }
-    props = _7HJPL3H2cjs.useHovercard.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
+    props = _I2KHXDVLcjs.useHovercard.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {
       store,
       alwaysVisible,
       initialFocus: initialFocusRef,
@@ -228,7 +228,7 @@ var useMenu = _RNZNGEL4cjs.createHook.call(void 0,
     return props;
   }
 );
-var Menu = _EKB76T2Ucjs.createDialogComponent.call(void 0, 
+var Menu = _ZL5DC555cjs.createDialogComponent.call(void 0, 
   _RNZNGEL4cjs.createComponent.call(void 0, (props) => {
     const htmlProps = useMenu(props);
     return _RNZNGEL4cjs.createElement.call(void 0, "div", htmlProps);

package/cjs/menu/menu.d.cts

@@ -17,10 +17,16 @@ import type { MenuListOptions } from "./menu-list.jsx";
  */
 export declare const useMenu: import("../utils/types.js").Hook<MenuOptions<"div">>;
 /**
- * Renders a dropdown menu element.
+ * Renders a dropdown menu element that's controlled by a
+ * [`MenuButton`](https://ariakit.org/reference/menu-button) component.
+ *
+ * This component uses the primitive
+ * [`MenuList`](https://ariakit.org/reference/menu-list) component under the
+ * hood. It renders a popover and automatically focuses on items when the menu
+ * is shown.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3-6}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>