@ariakit/react-core 0.3.11 → 0.3.13

package/esm/checkbox/checkbox-provider.d.ts

@@ -3,8 +3,10 @@ import type { PickRequired } from "@ariakit/core/utils/types";
 import type { CheckboxStoreProps, CheckboxStoreValue } from "./checkbox-store.js";
 type Value = CheckboxStoreValue;
 /**
- * Provides a checkbox store to its descendants. This is useful to create a
- * group of checkboxes that share the same store.
+ * Provides a checkbox store for its descendants. This comes in handy when
+ * creating a group of checkboxes that share the same state. `CheckboxProvider`
+ * can efficiently manage the value of a checkbox, whether it's a single string,
+ * number, or boolean value, or an array of such values.
  * @see https://ariakit.org/components/checkbox
  * @example
  * ```jsx

package/esm/checkbox/checkbox-provider.js

@@ -1,12 +1,12 @@
 "use client";
+import {
+  useCheckboxStore
+} from "../__chunks/JIZ5C2JK.js";
 import {
   CheckboxContextProvider
 } from "../__chunks/VPR2WHQV.js";
-import {
-  useCheckboxStore
-} from "../__chunks/IIVLUKKG.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/checkbox/checkbox-store.d.ts

@@ -3,7 +3,8 @@ import type { PickRequired } from "@ariakit/core/utils/types";
 import type { Store } from "../utils/store.js";
 export declare function useCheckboxStoreProps<T extends Core.CheckboxStore>(store: T, update: () => void, props: CheckboxStoreProps): T;
 /**
- * Creates a checkbox store.
+ * Creates a checkbox store to conveniently manage a checkbox value,
+ * whether it's a string, number, boolean, or an array of strings or numbers.
  * @see https://ariakit.org/components/checkbox
  * @example
  * ```jsx
@@ -18,8 +19,9 @@ export type CheckboxStoreState<T extends CheckboxStoreValue = CheckboxStoreValue
 export type CheckboxStoreFunctions<T extends CheckboxStoreValue = CheckboxStoreValue> = Core.CheckboxStoreFunctions<T>;
 export interface CheckboxStoreOptions<T extends CheckboxStoreValue = CheckboxStoreValue> extends Core.CheckboxStoreOptions<T> {
     /**
-     * A callback that gets called when the `value` state changes.
-     * @param value The new value.
+     * A callback that gets called when the
+     * [`value`](https://ariakit.org/reference/checkbox-provider#value) state
+     * changes.
      * @example
      * function MyCheckbox({ value, onChange }) {
      *   const checkbox = useCheckboxStore({ value, setValue: onChange });

package/esm/checkbox/checkbox-store.js

@@ -2,8 +2,8 @@
 import {
   useCheckboxStore,
   useCheckboxStoreProps
-} from "../__chunks/IIVLUKKG.js";
-import "../__chunks/4OZYHFMH.js";
+} from "../__chunks/JIZ5C2JK.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/checkbox/checkbox.d.ts

@@ -40,18 +40,21 @@ export interface CheckboxOptions<T extends As = "input"> extends CommandOptions<
     store?: CheckboxStore;
     /**
      * The native `name` attribute.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      */
     name?: string;
     /**
      * The value of the checkbox. This is useful when the same checkbox store is
-     * used for multiple `Checkbox` elements, in which case the value will be an
-     * array of checked values.
+     * used for multiple [`Checkbox`](https://ariakit.org/reference/checkbox)
+     * elements, in which case the value will be an array of checked values.
      *
      * Live examples:
      * - [Checkbox group](https://ariakit.org/examples/checkbox-group)
      * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      * @example
-     * ```jsx
+     * ```jsx "value"
      * <CheckboxProvider defaultValue={["Apple", "Orange"]}>
      *   <Checkbox value="Apple" />
      *   <Checkbox value="Orange" />
@@ -61,18 +64,20 @@ export interface CheckboxOptions<T extends As = "input"> extends CommandOptions<
      */
     value?: InputHTMLAttributes<HTMLInputElement>["value"];
     /**
-     * The default `checked` state of the checkbox. This prop is ignored if the
-     * `checked` or the `store` props are provided.
+     * The default checked state of the checkbox. This prop is ignored if the
+     * [`checked`](https://ariakit.org/reference/checkbox#checked) or the
+     * [`store`](https://ariakit.org/reference/checkbox#store) props are provided.
      */
     defaultChecked?: "mixed" | boolean;
     /**
-     * The `checked` state of the checkbox. This will override the value inferred
-     * from `store` prop, if provided. This can be `"mixed"` to indicate that the
-     * checkbox is partially checked.
+     * The checked state of the checkbox. This will override the value inferred
+     * from [`store`](https://ariakit.org/reference/checkbox#store) prop, if
+     * provided. This can be `"mixed"` to indicate that the checkbox is partially
+     * checked.
      */
     checked?: "mixed" | boolean;
     /**
-     * A function that is called when the checkbox's `checked` store changes.
+     * A function that is called when the checkbox's checked state changes.
      */
     onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
 }

package/esm/checkbox/checkbox.js

@@ -2,14 +2,14 @@
 import {
   Checkbox,
   useCheckbox
-} from "../__chunks/6H3EJNCE.js";
+} from "../__chunks/H5L25YOA.js";
 import "../__chunks/VPR2WHQV.js";
 import "../__chunks/6XBVQI3K.js";
-import "../__chunks/NWCBQ4CV.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/BVNGIDQK.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/collection/collection-item.d.ts

@@ -17,8 +17,10 @@ import type { CollectionStore } from "./collection-store.js";
 export declare const useCollectionItem: import("../utils/types.js").Hook<CollectionItemOptions<"div">>;
 /**
  * Renders an item in a collection. The collection store can be passed
- * explicitly through the `store` prop or implicitly through the parent
- * `Collection` component.
+ * explicitly through the
+ * [`store`](https://ariakit.org/reference/collection-item#store) prop or
+ * implicitly through the parent
+ * [`Collection`](https://ariakit.org/reference/collection) component.
  * @see https://ariakit.org/components/collection
  * @example
  * ```jsx
@@ -31,23 +33,42 @@ export declare const useCollectionItem: import("../utils/types.js").Hook<Collect
 export declare const CollectionItem: import("../utils/types.js").Component<CollectionItemOptions<"div">>;
 export interface CollectionItemOptions<T extends As = "div"> extends Options<T> {
     /**
-     * Object returned by the `useCollectionStore` hook. If not provided, the
-     * parent `Collection` component's context will be used.
+     * Object returned by the
+     * [`useCollectionStore`](https://ariakit.org/reference/use-collection-store)
+     * hook. If not provided, the closest
+     * [`Collection`](https://ariakit.org/reference/collection) or
+     * [`CollectionProvider`](https://ariakit.org/reference/collection-provider)
+     * components' context will be used.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     store?: CollectionStore;
     /**
-     * Whether the item should be registered to the store.
+     * The unique ID of the item. This will be used to register the item in the
+     * store and for the element's `id` attribute. If not provided, a unique ID
+     * will be automatically generated.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
+     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     */
+    id?: string;
+    /**
+     * Whether the item should be registered as part of the collection.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      * @default true
      */
     shouldRegisterItem?: boolean;
     /**
-     * A memoized function that returns props that will be passed along with the
-     * item when it gets registered to the store.
+     * A memoized function that returns props to be passed with the item during
+     * its registration in the store.
      * @example
      * ```jsx
-     * const store = useCollectionStore();
-     * const getItem = useCallback((item) => ({ ...item, custom: true }), []);
-     * <CollectionItem store={store} getItem={getItem} />
+     * const getItem = useCallback((data) => ({ ...data, custom: true }), []);
+     * <CollectionItem getItem={getItem} />
      * ```
      */
     getItem?: (props: CollectionStoreItem) => CollectionStoreItem;

package/esm/collection/collection-provider.d.ts

@@ -2,7 +2,8 @@ import type { ReactElement, ReactNode } from "react";
 import type { PickRequired } from "@ariakit/core/utils/types";
 import type { CollectionStoreItem, CollectionStoreProps } from "./collection-store.js";
 /**
- * Provides a collection store to CollectionItem components.
+ * Provides a collection store to
+ * [`CollectionItem`](https://ariakit.org/reference/collection-item) components.
  * @see https://ariakit.org/components/collection
  * @example
  * ```jsx

package/esm/collection/collection-provider.js

@@ -1,12 +1,12 @@
 "use client";
 import {
   useCollectionStore
-} from "../__chunks/HDMIVTNE.js";
+} from "../__chunks/Y6GYTNQ2.js";
 import {
   CollectionContextProvider
 } from "../__chunks/4UUKJZ4V.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/collection/collection-renderer.d.ts

@@ -327,7 +327,7 @@ export interface CollectionRendererOptions<T extends Item = any> {
     /**
      * Object returned by the
      * [`useCollectionStore`](https://ariakit.org/reference/use-collection-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [Collection](https://ariakit.org/components/collection) component's
      * context will be used.
      *

package/esm/collection/collection-renderer.js

@@ -4,10 +4,10 @@ import {
   getCollectionRendererItem,
   getCollectionRendererItemId,
   useCollectionRenderer
-} from "../__chunks/GD2VG2KJ.js";
+} from "../__chunks/4HD64GHO.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/collection/collection-store.d.ts

@@ -3,11 +3,13 @@ import type { BivariantCallback, PickRequired } from "@ariakit/core/utils/types"
 import type { Store } from "../utils/store.js";
 export declare function useCollectionStoreProps<T extends Core.CollectionStore>(store: T, update: () => void, props: CollectionStoreProps): T;
 /**
- * Creates a collection store.
+ * Creates a collection store to control
+ * [Collection](https://ariakit.org/components/collection) components.
  * @see https://ariakit.org/components/collection
  * @example
  * ```jsx
  * const collection = useCollectionStore();
+ *
  * <Collection store={collection}>
  *   <CollectionItem>Item</CollectionItem>
  *   <CollectionItem>Item</CollectionItem>
@@ -25,8 +27,9 @@ export interface CollectionStoreFunctions<T extends CollectionStoreItem = Collec
 }
 export interface CollectionStoreOptions<T extends CollectionStoreItem = CollectionStoreItem> extends Core.CollectionStoreOptions<T> {
     /**
-     * A callback that gets called when the `items` state changes.
-     * @param items The new items.
+     * A callback that gets called when the
+     * [`items`](https://ariakit.org/reference/collection-provider#items) state
+     * changes.
      * @example
      * const [items, setItems] = useState([]);
      * const collection = useCollectionStore({ items, setItems });

package/esm/collection/collection-store.js

@@ -2,8 +2,8 @@
 import {
   useCollectionStore,
   useCollectionStoreProps
-} from "../__chunks/HDMIVTNE.js";
-import "../__chunks/4OZYHFMH.js";
+} from "../__chunks/Y6GYTNQ2.js";
+import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";

package/esm/collection/collection.d.ts

@@ -18,9 +18,10 @@ import type { CollectionStore } from "./collection-store.js";
  */
 export declare const useCollection: import("../utils/types.js").Hook<CollectionOptions<"div">>;
 /**
- * Renders a simple wrapper for collection items. It receives the collection
- * store through the `store` prop and provides context for `CollectionItem`
- * components.
+ * Renders a simple wrapper for collection items. It accepts a collection store
+ * through the [`store`](https://ariakit.org/reference/collection#store) prop
+ * and provides context for
+ * [`CollectionItem`](https://ariakit.org/reference/collection-item) components.
  * @see https://ariakit.org/components/collection
  * @example
  * ```jsx

package/esm/combobox/combobox-cancel.d.ts

@@ -15,10 +15,11 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxCancel: import("../utils/types.js").Hook<ComboboxCancelOptions<"button">>;
 /**
- * Renders a combobox cancel button that clears the combobox input when clicked.
+ * Renders a combobox cancel button that clears the combobox input value when
+ * clicked.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {3}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxCancel />

package/esm/combobox/combobox-cancel.js

@@ -1,17 +1,17 @@
 "use client";
 import {
   useButton
-} from "../__chunks/VDNZBO4W.js";
+} from "../__chunks/JH4A3V7P.js";
 import {
   useComboboxProviderContext
 } from "../__chunks/W76OTZCC.js";
-import "../__chunks/NWCBQ4CV.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/7H5KSHHF.js";
 import "../__chunks/G6BJYYBK.js";
 import "../__chunks/OAYFXAQ2.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,

package/esm/combobox/combobox-disclosure.d.ts

@@ -20,11 +20,16 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxDisclosure: import("../utils/types.js").Hook<ComboboxDisclosureOptions<"button">>;
 /**
- * Renders a combobox disclosure button that toggles the combobox popover
+ * Renders a combobox disclosure button that toggles the
+ * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover) element's
  * visibility when clicked.
+ *
+ * Although this button is not tabbable, it remains accessible to screen reader
+ * users. On clicking, it automatically shifts focus to the
+ * [`Combobox`](https://ariakit.org/reference/combobox) element.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {3}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxDisclosure />

package/esm/combobox/combobox-disclosure.js

@@ -1,19 +1,19 @@
 "use client";
 import {
   useDialogDisclosure
-} from "../__chunks/H3TG2CZP.js";
-import "../__chunks/BHEJ6NUH.js";
-import "../__chunks/VDNZBO4W.js";
+} from "../__chunks/PUBUTPR6.js";
+import "../__chunks/CM2MGWJJ.js";
+import "../__chunks/JH4A3V7P.js";
 import {
   useComboboxProviderContext
 } from "../__chunks/W76OTZCC.js";
-import "../__chunks/NWCBQ4CV.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/7H5KSHHF.js";
 import "../__chunks/G6BJYYBK.js";
 import "../__chunks/OAYFXAQ2.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,

package/esm/combobox/combobox-group-label.d.ts

@@ -16,11 +16,11 @@ import type { ComboboxStore } from "./combobox-store.js";
 export declare const useComboboxGroupLabel: import("../utils/types.js").Hook<ComboboxGroupLabelOptions<"div">>;
 /**
  * Renders a label in a combobox group. This component should be wrapped with
- * `ComboboxGroup` so the `aria-labelledby` is correctly set on the combobox
- * group element.
+ * [`ComboboxGroup`](https://ariakit.org/reference/combobox-group) so the
+ * `aria-labelledby` is correctly set on the group element.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {5}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxPopover>
@@ -38,7 +38,7 @@ export interface ComboboxGroupLabelOptions<T extends As = "div"> extends Composi
     /**
      * Object returned by the
      * [`useComboboxStore`](https://ariakit.org/reference/use-combobox-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
      * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
      * components' context will be used.

package/esm/combobox/combobox-group.d.ts

@@ -20,10 +20,14 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxGroup: import("../utils/types.js").Hook<ComboboxGroupOptions<"div">>;
 /**
- * Renders a combobox group.
+ * Renders a group for
+ * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) elements.
+ * Optionally, a
+ * [`ComboboxGroupLabel`](https://ariakit.org/reference/combobox-group-label)
+ * can be rendered as a child to provide a label for the group.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {4-8}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxPopover>
@@ -41,7 +45,7 @@ export interface ComboboxGroupOptions<T extends As = "div"> extends CompositeGro
     /**
      * Object returned by the
      * [`useComboboxStore`](https://ariakit.org/reference/use-combobox-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
      * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
      * components' context will be used.

package/esm/combobox/combobox-item-check.d.ts

@@ -14,12 +14,15 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxItemCheck: import("../utils/types.js").Hook<ComboboxItemCheckOptions<"span">>;
 /**
- * Renders a checkmark inside a
- * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) component. This
- * component must be wrapped with
- * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) or the
+ * Renders a checkmark icon when the
  * [`checked`](https://ariakit.org/reference/combobox-item-check#checked) prop
- * must be explicitly passed to the component.
+ * is `true`. The icon can be overridden by providing a different one as
+ * children.
+ *
+ * When rendered inside a
+ * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) component, the
+ * [`checked`](https://ariakit.org/reference/combobox-item-check#checked) prop
+ * is automatically derived from the context.
  * @see https://ariakit.org/components/combobox
  * @example
  * ```jsx {5,9}
@@ -43,18 +46,8 @@ export interface ComboboxItemCheckOptions<T extends As = "span"> extends Checkbo
     /**
      * Object returned by the
      * [`useComboboxStore`](https://ariakit.org/reference/use-combobox-store)
-     * hook. If not provided, the parent
-     * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
-     * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
-     * components' context will be used.
+     * hook.
      */
     store?: ComboboxStore;
-    /**
-     * Whether the check mark should be shown. This value is automatically
-     * inferred from the parent
-     * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) component.
-     * Manually setting this prop will override the inferred value.
-     */
-    checked?: boolean;
 }
 export type ComboboxItemCheckProps<T extends As = "span"> = Props<ComboboxItemCheckOptions<T>>;

package/esm/combobox/combobox-item-value.d.ts

@@ -23,13 +23,16 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxItemValue: import("../utils/types.js").Hook<ComboboxItemValueOptions<"span">>;
 /**
- * Renders a value element inside a combobox item. The value will be split into
- * span elements. The portions of the value that correspond to the store value
- * will have a `data-user-value` attribute. The other portions will have a
- * `data-autocomplete-value` attribute.
+ * Renders a value element inside a
+ * [`ComboboxItem`](https://ariakit.org/reference/combobox-item). The value will
+ * be split into span elements. The portions of the value that correspond to the
+ * combobox value will have a
+ * [`data-user-value`](https://ariakit.org/guide/styling#data-user-value)
+ * attribute. The other portions will have a [`data-autocomplete-value`](https://ariakit.org/guide/styling#data-autocomplete-value)
+ * attribute.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {5} "value"
  * <ComboboxProvider value="p">
  *   <Combobox />
  *   <ComboboxPopover>
@@ -53,15 +56,17 @@ export interface ComboboxItemValueOptions<T extends As = "span"> extends Options
     /**
      * Object returned by the
      * [`useComboboxStore`](https://ariakit.org/reference/use-combobox-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
      * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
      * components' context will be used.
      */
     store?: ComboboxStore;
     /**
-     * The current combobox item value. If not provided, the parent `ComboboxItem`
-     * component's `value` prop will be used.
+     * The current combobox item value. If not provided, the parent
+     * [`ComboboxItem`](https://ariakit.org/reference/combobox-item) component's
+     * [`value`](https://ariakit.org/reference/combobox-item#value) prop will be
+     * used.
      */
     value?: string;
 }

package/esm/combobox/combobox-item.d.ts

@@ -16,19 +16,16 @@ import type { ComboboxStore } from "./combobox-store.js";
  */
 export declare const useComboboxItem: import("../utils/types.js").Hook<ComboboxItemOptions<"div">>;
 /**
- * Renders a combobox item inside a
+ * Renders a combobox item inside
  * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
  * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
- * components. The `role` prop will be automatically set based on the list's own
- * `role` prop. For example, if the list `role` is set to `listbox` (default),
- * the `ComboboxItem` `role` will be set to `option`.
+ * components.
  *
- * By default, the
- * [`value`](https://ariakit.org/reference/combobox-item#value) prop will be
- * rendered as the children, but this can be overriden.
+ * By default, the [`value`](https://ariakit.org/reference/combobox-item#value)
+ * prop will be rendered as the children, but this can be overriden.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {4-6}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxPopover>
@@ -44,10 +41,13 @@ export interface ComboboxItemOptions<T extends As = "div"> extends CompositeItem
     /**
      * Object returned by the
      * [`useComboboxStore`](https://ariakit.org/reference/use-combobox-store)
-     * hook. If not provided, the parent
+     * hook. If not provided, the closest
      * [`ComboboxList`](https://ariakit.org/reference/combobox-list) or
      * [`ComboboxPopover`](https://ariakit.org/reference/combobox-popover)
      * components' context will be used.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     store?: ComboboxStore;
     /**
@@ -86,6 +86,8 @@ export interface ComboboxItemOptions<T extends As = "div"> extends CompositeItem
      *
      * Live examples:
      * - [Combobox with links](https://ariakit.org/examples/combobox-links)
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
     hideOnClick?: BooleanOrCallback<MouseEvent<HTMLElement>>;
     /**

package/esm/combobox/combobox-item.js

@@ -9,23 +9,23 @@ import {
 } from "../__chunks/W76OTZCC.js";
 import {
   useCompositeItem
-} from "../__chunks/R2WNOXYG.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/W7TET3D7.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/UH3I23HL.js";
-import "../__chunks/6QXBPV75.js";
+import "../__chunks/3IEDWLST.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
 import "../__chunks/7H5KSHHF.js";
 import "../__chunks/G6BJYYBK.js";
 import "../__chunks/OAYFXAQ2.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createElement,
   createHook,
   createMemoComponent
 } from "../__chunks/3ORBWXWF.js";
-import "../__chunks/4OZYHFMH.js";
+import "../__chunks/EKQEJRUF.js";
 import {
   useBooleanEvent,
   useEvent,

package/esm/combobox/combobox-list.d.ts

@@ -21,12 +21,9 @@ export declare const useComboboxList: import("../utils/types.js").Hook<ComboboxL
  * Renders a combobox list. The `role` prop is set to `listbox` by default, but
  * can be overriden by any other valid combobox popup role (`listbox`, `menu`,
  * `tree`, `grid` or `dialog`).
- *
- * The `aria-labelledby` prop is set to the combobox input element's `id` by
- * default.
  * @see https://ariakit.org/components/combobox
  * @example
- * ```jsx
+ * ```jsx {3-7}
  * <ComboboxProvider>
  *   <Combobox />
  *   <ComboboxList>