@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/hovercard/hovercard-dismiss.d.cts

@@ -15,10 +15,11 @@ import type { HovercardStore } from "./hovercard-store.js";
  */
 export declare const useHovercardDismiss: import("../utils/types.js").Hook<HovercardDismissOptions<"button">>;
 /**
- * Renders a button that hides a hovercard.
+ * Renders a button that hides a
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) when clicked.
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <Hovercard>
  *     <HovercardDismiss />

package/cjs/hovercard/hovercard-dismiss.d.ts

@@ -15,10 +15,11 @@ import type { HovercardStore } from "./hovercard-store.js";
  */
 export declare const useHovercardDismiss: import("../utils/types.js").Hook<HovercardDismissOptions<"button">>;
 /**
- * Renders a button that hides a hovercard.
+ * Renders a button that hides a
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) when clicked.
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <Hovercard>
  *     <HovercardDismiss />

package/cjs/hovercard/hovercard-heading.d.cts

@@ -17,10 +17,10 @@ export declare const useHovercardHeading: import("../utils/types.js").Hook<Hover
 /**
  * Renders a heading in a hovercard. This component must be wrapped within
  * [`Hovercard`](https://ariakit.org/reference/hovercard) so the
- * `aria-labelledby` prop is properly set on the hovercard element.
+ * `aria-labelledby` prop is properly set on the content element.
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <Hovercard>
  *     <HovercardHeading>Heading</HovercardHeading>

package/cjs/hovercard/hovercard-heading.d.ts

@@ -17,10 +17,10 @@ export declare const useHovercardHeading: import("../utils/types.js").Hook<Hover
 /**
  * Renders a heading in a hovercard. This component must be wrapped within
  * [`Hovercard`](https://ariakit.org/reference/hovercard) so the
- * `aria-labelledby` prop is properly set on the hovercard element.
+ * `aria-labelledby` prop is properly set on the content element.
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <Hovercard>
  *     <HovercardHeading>Heading</HovercardHeading>

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

@@ -1,7 +1,8 @@
 import type { ReactNode } from "react";
 import type { HovercardStoreProps } from "./hovercard-store.js";
 /**
- * Provides a hovercard store to Hovercard components.
+ * Provides a hovercard store to
+ * [Hovercard](https://ariakit.org/components/hovercard) components.
  * @see https://ariakit.org/components/hovercard
  * @example
  * ```jsx

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

@@ -1,7 +1,8 @@
 import type { ReactNode } from "react";
 import type { HovercardStoreProps } from "./hovercard-store.js";
 /**
- * Provides a hovercard store to Hovercard components.
+ * Provides a hovercard store to
+ * [Hovercard](https://ariakit.org/components/hovercard) components.
  * @see https://ariakit.org/components/hovercard
  * @example
  * ```jsx

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

@@ -3,7 +3,8 @@ import type { PopoverStoreFunctions, PopoverStoreOptions, PopoverStoreState } fr
 import type { Store } from "../utils/store.js";
 export declare function useHovercardStoreProps<T extends Core.HovercardStore>(store: T, update: () => void, props: HovercardStoreProps): T;
 /**
- * Creates a hovercard store.
+ * Creates a hovercard store to control the state of
+ * [Hovercard](https://ariakit.org/reference/hovercard) components.
  * @see https://ariakit.org/components/hovercard
  * @example
  * ```jsx

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

@@ -3,7 +3,8 @@ import type { PopoverStoreFunctions, PopoverStoreOptions, PopoverStoreState } fr
 import type { Store } from "../utils/store.js";
 export declare function useHovercardStoreProps<T extends Core.HovercardStore>(store: T, update: () => void, props: HovercardStoreProps): T;
 /**
- * Creates a hovercard store.
+ * Creates a hovercard store to control the state of
+ * [Hovercard](https://ariakit.org/reference/hovercard) components.
  * @see https://ariakit.org/components/hovercard
  * @example
  * ```jsx

package/cjs/hovercard/hovercard.cjs

@@ -2,12 +2,12 @@
 
 
 
-var _7HJPL3H2cjs = require('../__chunks/7HJPL3H2.cjs');
+var _I2KHXDVLcjs = require('../__chunks/I2KHXDVL.cjs');
 require('../__chunks/KXQOQQ5B.cjs');
-require('../__chunks/KDG57VZV.cjs');
-require('../__chunks/EKB76T2U.cjs');
+require('../__chunks/OUEE5HOS.cjs');
+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');
@@ -15,11 +15,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');
@@ -45,4 +45,4 @@ require('../__chunks/AV6KTKLE.cjs');
 
 
 
-exports.Hovercard = _7HJPL3H2cjs.Hovercard; exports.useHovercard = _7HJPL3H2cjs.useHovercard;
+exports.Hovercard = _I2KHXDVLcjs.Hovercard; exports.useHovercard = _I2KHXDVLcjs.useHovercard;

package/cjs/hovercard/hovercard.d.cts

@@ -20,7 +20,7 @@ export declare const useHovercard: import("../utils/types.js").Hook<HovercardOpt
  * [`HovercardAnchor`](https://ariakit.org/reference/hovercard-anchor).
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <HovercardAnchor>@username</HovercardAnchor>
  *   <Hovercard>Details</Hovercard>
@@ -38,17 +38,29 @@ export interface HovercardOptions<T extends As = "div"> extends PopoverOptions<T
      */
     store?: HovercardStore;
     /**
-     * Whether to hide the popover when the mouse cursor leaves any hovercard
-     * element, including the hovercard popover itself, but also the anchor
-     * element.
+     * Determines whether the popover should hide when the mouse leaves the
+     * popover or the anchor element and there's no _hover intent_, meaning, the
+     * mouse isn't moving toward the popover.
+     *
+     * This can be either a boolean or a callback receiving the mouse move event
+     * that initiated the behavior. The callback should return a boolean.
+     *
+     * **Note**: This behavior won't be triggered when the popover or any of its
+     * descendants are in focus.
      * @default true
      */
     hideOnHoverOutside?: BooleanOrCallback<MouseEvent>;
     /**
-     * Whether to disable the pointer events outside of the hovercard while the
-     * mouse is moving toward the hovercard. This is necessary because these
-     * events may trigger focus on other elements and close the hovercard while
-     * the user is moving the mouse toward it.
+     * Determines if the pointer events outside of the popover and its anchor
+     * element should be disabled during _hover intent_, that is, when the mouse
+     * is moving toward the popover.
+     *
+     * This is required as these external events may trigger focus on other
+     * elements and close the popover while the user is attempting to hover over
+     * it.
+     *
+     * This can be either a boolean or a callback receiving the mouse event
+     * happening during hover intent. The callback should return a boolean.
      * @default true
      */
     disablePointerEventsOnApproach?: BooleanOrCallback<MouseEvent>;

package/cjs/hovercard/hovercard.d.ts

@@ -20,7 +20,7 @@ export declare const useHovercard: import("../utils/types.js").Hook<HovercardOpt
  * [`HovercardAnchor`](https://ariakit.org/reference/hovercard-anchor).
  * @see https://ariakit.org/components/hovercard
  * @example
- * ```jsx
+ * ```jsx {3}
  * <HovercardProvider>
  *   <HovercardAnchor>@username</HovercardAnchor>
  *   <Hovercard>Details</Hovercard>
@@ -38,17 +38,29 @@ export interface HovercardOptions<T extends As = "div"> extends PopoverOptions<T
      */
     store?: HovercardStore;
     /**
-     * Whether to hide the popover when the mouse cursor leaves any hovercard
-     * element, including the hovercard popover itself, but also the anchor
-     * element.
+     * Determines whether the popover should hide when the mouse leaves the
+     * popover or the anchor element and there's no _hover intent_, meaning, the
+     * mouse isn't moving toward the popover.
+     *
+     * This can be either a boolean or a callback receiving the mouse move event
+     * that initiated the behavior. The callback should return a boolean.
+     *
+     * **Note**: This behavior won't be triggered when the popover or any of its
+     * descendants are in focus.
      * @default true
      */
     hideOnHoverOutside?: BooleanOrCallback<MouseEvent>;
     /**
-     * Whether to disable the pointer events outside of the hovercard while the
-     * mouse is moving toward the hovercard. This is necessary because these
-     * events may trigger focus on other elements and close the hovercard while
-     * the user is moving the mouse toward it.
+     * Determines if the pointer events outside of the popover and its anchor
+     * element should be disabled during _hover intent_, that is, when the mouse
+     * is moving toward the popover.
+     *
+     * This is required as these external events may trigger focus on other
+     * elements and close the popover while the user is attempting to hover over
+     * it.
+     *
+     * This can be either a boolean or a callback receiving the mouse event
+     * happening during hover intent. The callback should return a boolean.
      * @default true
      */
     disablePointerEventsOnApproach?: BooleanOrCallback<MouseEvent>;

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

@@ -16,10 +16,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuArrow: import("../utils/types.js").Hook<MenuArrowOptions<"div">>;
 /**
- * Renders an arrow inside the menu element.
+ * Renders an arrow element inside a
+ * [`Menu`](https://ariakit.org/reference/menu) component that points to its
+ * [`MenuButton`](https://ariakit.org/reference/menu-button).
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4}
  * <MenuProvider>
  *   <MenuButton>Menu</MenuButton>
  *   <Menu>

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

@@ -16,10 +16,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuArrow: import("../utils/types.js").Hook<MenuArrowOptions<"div">>;
 /**
- * Renders an arrow inside the menu element.
+ * Renders an arrow element inside a
+ * [`Menu`](https://ariakit.org/reference/menu) component that points to its
+ * [`MenuButton`](https://ariakit.org/reference/menu-button).
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4}
  * <MenuProvider>
  *   <MenuButton>Menu</MenuButton>
  *   <Menu>

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

@@ -2,8 +2,7 @@ import type { MenubarOptions } from "../menubar/menubar.js";
 import type { As, Props } from "../utils/types.js";
 /**
  * Returns props to create a `MenuBar` component.
- * @deprecated
- * Use [`useMenubar`](https://ariakit.org/reference/use-menubar) instead.
+ * @deprecated Use `useMenubar` instead.
  * @example
  * ```jsx
  * const store = useMenuBarStore();

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

@@ -2,8 +2,7 @@ import type { MenubarOptions } from "../menubar/menubar.js";
 import type { As, Props } from "../utils/types.js";
 /**
  * Returns props to create a `MenuBar` component.
- * @deprecated
- * Use [`useMenubar`](https://ariakit.org/reference/use-menubar) instead.
+ * @deprecated Use `useMenubar` instead.
  * @example
  * ```jsx
  * const store = useMenuBarStore();

package/cjs/menu/menu-button-arrow.d.cts

@@ -20,12 +20,17 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuButtonArrow: import("../utils/types.js").Hook<MenuButtonArrowOptions<"span">>;
 /**
- * Renders an arrow pointing to the menu position, usually inside a
- * `MenuButton`.
+ * Displays an arrow within a
+ * [`MenuButton`](https://ariakit.org/reference/menu-button), pointing to the
+ * [`Menu`](https://ariakit.org/reference/menu) position. It's typically based
+ * on the [`placement`](https://ariakit.org/reference/menu-provider#placement)
+ * state from the menu store, but this can be overridden with the
+ * [`placement`](https://ariakit.org/reference/menu-button-arrow#placement)
+ * prop.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider>
+ * ```jsx {4}
+ * <MenuProvider placement="bottom-start">
  *   <MenuButton>
  *     Edit
  *     <MenuButtonArrow />

package/cjs/menu/menu-button-arrow.d.ts

@@ -20,12 +20,17 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuButtonArrow: import("../utils/types.js").Hook<MenuButtonArrowOptions<"span">>;
 /**
- * Renders an arrow pointing to the menu position, usually inside a
- * `MenuButton`.
+ * Displays an arrow within a
+ * [`MenuButton`](https://ariakit.org/reference/menu-button), pointing to the
+ * [`Menu`](https://ariakit.org/reference/menu) position. It's typically based
+ * on the [`placement`](https://ariakit.org/reference/menu-provider#placement)
+ * state from the menu store, but this can be overridden with the
+ * [`placement`](https://ariakit.org/reference/menu-button-arrow#placement)
+ * prop.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
- * <MenuProvider>
+ * ```jsx {4}
+ * <MenuProvider placement="bottom-start">
  *   <MenuButton>
  *     Edit
  *     <MenuButtonArrow />

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

@@ -19,13 +19,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuButton: import("../utils/types.js").Hook<MenuButtonOptions<"button" | "div">>;
 /**
- * Renders a menu button that triggers a
- * [`Menu`](https://ariakit.org/reference/menu) component. Usually, this is
- * rendered as a native `button` element, but if it's a submenu button rendered
- * as a menu item inside another menu, it'll be rendered as a `div`.
+ * Renders a menu button that toggles the visibility of a
+ * [`Menu`](https://ariakit.org/reference/menu) component when clicked or when
+ * using arrow keys.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {2}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>
@@ -49,8 +48,10 @@ export interface MenuButtonOptions<T extends As = "button" | "div"> extends Hove
      * Determines whether pressing a character key while focusing on the
      * [`MenuButton`](https://ariakit.org/reference/menu-button) should move focus
      * to the [`MenuItem`](https://ariakit.org/reference/menu-item) starting with
-     * that character. By default, it's `true` for menu buttons in a
-     * [Menubar](https://ariakit.org/components/menubar), but `false` for other
+     * that character.
+     *
+     * By default, it's `true` for menu buttons in a
+     * [`Menubar`](https://ariakit.org/reference/menubar), but `false` for other
      * menu buttons.
      */
     typeahead?: boolean;

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

@@ -19,13 +19,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuButton: import("../utils/types.js").Hook<MenuButtonOptions<"button" | "div">>;
 /**
- * Renders a menu button that triggers a
- * [`Menu`](https://ariakit.org/reference/menu) component. Usually, this is
- * rendered as a native `button` element, but if it's a submenu button rendered
- * as a menu item inside another menu, it'll be rendered as a `div`.
+ * Renders a menu button that toggles the visibility of a
+ * [`Menu`](https://ariakit.org/reference/menu) component when clicked or when
+ * using arrow keys.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {2}
  * <MenuProvider>
  *   <MenuButton>Edit</MenuButton>
  *   <Menu>
@@ -49,8 +48,10 @@ export interface MenuButtonOptions<T extends As = "button" | "div"> extends Hove
      * Determines whether pressing a character key while focusing on the
      * [`MenuButton`](https://ariakit.org/reference/menu-button) should move focus
      * to the [`MenuItem`](https://ariakit.org/reference/menu-item) starting with
-     * that character. By default, it's `true` for menu buttons in a
-     * [Menubar](https://ariakit.org/components/menubar), but `false` for other
+     * that character.
+     *
+     * By default, it's `true` for menu buttons in a
+     * [`Menubar`](https://ariakit.org/reference/menubar), but `false` for other
      * menu buttons.
      */
     typeahead?: boolean;

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

@@ -15,12 +15,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuDescription: import("../utils/types.js").Hook<MenuDescriptionOptions<"p">>;
 /**
- * Renders a description in a menu. This component must be wrapped with
+ * Renders a description in a menu. This component must be wrapped with a
  * [`Menu`](https://ariakit.org/reference/menu) component so the
  * `aria-describedby` prop is properly set on the menu element.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3}
  * <MenuProvider>
  *   <Menu>
  *     <MenuDescription>Description</MenuDescription>

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

@@ -15,12 +15,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuDescription: import("../utils/types.js").Hook<MenuDescriptionOptions<"p">>;
 /**
- * Renders a description in a menu. This component must be wrapped with
+ * Renders a description in a menu. This component must be wrapped with a
  * [`Menu`](https://ariakit.org/reference/menu) component so the
  * `aria-describedby` prop is properly set on the menu element.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3}
  * <MenuProvider>
  *   <Menu>
  *     <MenuDescription>Description</MenuDescription>

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

@@ -15,10 +15,11 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuDismiss: import("../utils/types.js").Hook<MenuDismissOptions<"button">>;
 /**
- * Renders a button that hides a menu.
+ * Renders a button that hides a [`Menu`](https://ariakit.org/reference/menu)
+ * when clicked.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3}
  * <MenuProvider>
  *   <Menu>
  *     <MenuDismiss />

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

@@ -15,10 +15,11 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuDismiss: import("../utils/types.js").Hook<MenuDismissOptions<"button">>;
 /**
- * Renders a button that hides a menu.
+ * Renders a button that hides a [`Menu`](https://ariakit.org/reference/menu)
+ * when clicked.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {3}
  * <MenuProvider>
  *   <Menu>
  *     <MenuDismiss />

package/cjs/menu/menu-group-label.d.cts

@@ -15,12 +15,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuGroupLabel: import("../utils/types.js").Hook<MenuGroupLabelOptions<"div">>;
 /**
- * Renders a label in a menu group. This component must be wrapped with
- * `MenuGroup` so the `aria-labelledby` prop is properly set on the menu group
- * element.
+ * Renders a label in a menu group. This component should be wrapped with
+ * [`MenuGroup`](https://ariakit.org/reference/menu-group) so the
+ * `aria-labelledby` is correctly set on the group element.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {5}
  * <MenuProvider>
  *   <MenuButton>Recent Items</MenuButton>
  *   <Menu>

package/cjs/menu/menu-group-label.d.ts

@@ -15,12 +15,12 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuGroupLabel: import("../utils/types.js").Hook<MenuGroupLabelOptions<"div">>;
 /**
- * Renders a label in a menu group. This component must be wrapped with
- * `MenuGroup` so the `aria-labelledby` prop is properly set on the menu group
- * element.
+ * Renders a label in a menu group. This component should be wrapped with
+ * [`MenuGroup`](https://ariakit.org/reference/menu-group) so the
+ * `aria-labelledby` is correctly set on the group element.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {5}
  * <MenuProvider>
  *   <MenuButton>Recent Items</MenuButton>
  *   <Menu>

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

@@ -20,10 +20,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuGroup: import("../utils/types.js").Hook<MenuGroupOptions<"div">>;
 /**
- * Renders a menu group inside a menu.
+ * Renders a group for [`MenuItem`](https://ariakit.org/reference/menu-item)
+ * elements. Optionally, a
+ * [`MenuGroupLabel`](https://ariakit.org/reference/menu-group-label) can be
+ * rendered as a child to provide a label for the group.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4-8}
  * <MenuProvider>
  *   <MenuButton>Recent Items</MenuButton>
  *   <Menu>

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

@@ -20,10 +20,13 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuGroup: import("../utils/types.js").Hook<MenuGroupOptions<"div">>;
 /**
- * Renders a menu group inside a menu.
+ * Renders a group for [`MenuItem`](https://ariakit.org/reference/menu-item)
+ * elements. Optionally, a
+ * [`MenuGroupLabel`](https://ariakit.org/reference/menu-group-label) can be
+ * rendered as a child to provide a label for the group.
  * @see https://ariakit.org/components/menu
  * @example
- * ```jsx
+ * ```jsx {4-8}
  * <MenuProvider>
  *   <MenuButton>Recent Items</MenuButton>
  *   <Menu>

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

@@ -15,8 +15,9 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuHeading: import("../utils/types.js").Hook<MenuHeadingOptions<"h1">>;
 /**
- * Renders a heading in a menu. This component must be wrapped with `Menu` so
- * the `aria-labelledby` prop is properly set on the menu element.
+ * Renders a heading in a menu. This component must be wrapped within
+ * [`Menu`](https://ariakit.org/reference/menu) so the `aria-labelledby` prop is
+ * properly set on the content element.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx

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

@@ -15,8 +15,9 @@ import type { MenuStore } from "./menu-store.js";
  */
 export declare const useMenuHeading: import("../utils/types.js").Hook<MenuHeadingOptions<"h1">>;
 /**
- * Renders a heading in a menu. This component must be wrapped with `Menu` so
- * the `aria-labelledby` prop is properly set on the menu element.
+ * Renders a heading in a menu. This component must be wrapped within
+ * [`Menu`](https://ariakit.org/reference/menu) so the `aria-labelledby` prop is
+ * properly set on the content element.
  * @see https://ariakit.org/components/menu
  * @example
  * ```jsx

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

@@ -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>>;