@ariakit/react-core 0.3.12 → 0.3.14

package/cjs/tooltip/tooltip.cjs

@@ -1,14 +1,14 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-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');
@@ -16,11 +16,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');
@@ -94,7 +94,7 @@ var useTooltip = _RNZNGEL4cjs.createHook.call(void 0,
       (state) => state.type === "description" ? "tooltip" : "none"
     );
     props = _AV6KTKLEcjs.__spreadValues.call(void 0, { role }, props);
-    props = _7HJPL3H2cjs.useHovercard.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
+    props = _I2KHXDVLcjs.useHovercard.call(void 0, _AV6KTKLEcjs.__spreadProps.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, {}, props), {
       store,
       portal,
       gutter,
@@ -123,7 +123,7 @@ var useTooltip = _RNZNGEL4cjs.createHook.call(void 0,
     return props;
   }
 );
-var Tooltip = _EKB76T2Ucjs.createDialogComponent.call(void 0, 
+var Tooltip = _ZL5DC555cjs.createDialogComponent.call(void 0, 
   _RNZNGEL4cjs.createComponent.call(void 0, (props) => {
     const htmlProps = useTooltip(props);
     return _RNZNGEL4cjs.createElement.call(void 0, "div", htmlProps);

package/cjs/tooltip/tooltip.d.cts

@@ -14,7 +14,9 @@ import type { TooltipStore } from "./tooltip-store.js";
  */
 export declare const useTooltip: import("../utils/types.js").Hook<TooltipOptions<"div">>;
 /**
- * Renders a tooltip element.
+ * Renders a tooltip element that visually describes a
+ * [`TooltipAnchor`](https://ariakit.org/reference/tooltip-anchor) when it
+ * receives focus or is hovered.
  * @see https://ariakit.org/components/tooltip
  * @example
  * ```jsx {3}

package/cjs/tooltip/tooltip.d.ts

@@ -14,7 +14,9 @@ import type { TooltipStore } from "./tooltip-store.js";
  */
 export declare const useTooltip: import("../utils/types.js").Hook<TooltipOptions<"div">>;
 /**
- * Renders a tooltip element.
+ * Renders a tooltip element that visually describes a
+ * [`TooltipAnchor`](https://ariakit.org/reference/tooltip-anchor) when it
+ * receives focus or is hovered.
  * @see https://ariakit.org/components/tooltip
  * @example
  * ```jsx {3}

package/esm/__chunks/{FS2EVEJO.js → 4GO43MST.js}

@@ -22,7 +22,7 @@ import {
   __spreadValues
 } from "./4R3V3JGP.js";
 
-// src/form/form-field.ts
+// src/form/form-control.ts
 import { useCallback, useRef } from "react";
 import { getDocument } from "@ariakit/core/utils/dom";
 import { cx, invariant } from "@ariakit/core/utils/misc";
@@ -43,7 +43,7 @@ function useItem(store, name, type) {
     (state) => state.items.find((item) => item.type === type && item.name === name)
   );
 }
-var useFormField = createHook(
+var useFormControl = createHook(
   (_a) => {
     var _b = _a, {
       store,
@@ -60,7 +60,7 @@ var useFormField = createHook(
     store = store || context;
     invariant(
       store,
-      process.env.NODE_ENV !== "production" && "FormField must be wrapped in a Form component."
+      process.env.NODE_ENV !== "production" && "FormControl must be wrapped in a Form component."
     );
     const name = `${nameProp}`;
     const id = useId(props.id);
@@ -118,15 +118,15 @@ var useFormField = createHook(
     return props;
   }
 );
-var FormField = createMemoComponent((props) => {
-  const htmlProps = useFormField(props);
+var FormControl = createMemoComponent((props) => {
+  const htmlProps = useFormControl(props);
   return createElement("input", htmlProps);
 });
 if (process.env.NODE_ENV !== "production") {
-  FormField.displayName = "FormField";
+  FormControl.displayName = "FormControl";
 }
 
 export {
-  useFormField,
-  FormField
+  useFormControl,
+  FormControl
 };

package/esm/__chunks/{A6XC27R5.js → IRX7SFUJ.js}

@@ -2,7 +2,7 @@
 import {
   createDialogComponent,
   useDialog
-} from "./PGAEII2Q.js";
+} from "./NERBASET.js";
 import {
   PopoverScopedContextProvider,
   usePopoverProviderContext

package/esm/__chunks/{PGAEII2Q.js → NERBASET.js}

@@ -5,7 +5,7 @@ import {
 import {
   disableTree,
   disableTreeOutside
-} from "./CLF4PQ7T.js";
+} from "./TQYOGOE2.js";
 import {
   usePreventBodyScroll
 } from "./6BJGLK2C.js";
@@ -19,12 +19,12 @@ import {
   isElementMarked,
   markTreeOutside
 } from "./TL67WVI6.js";
-import {
-  prependHiddenDismiss
-} from "./6GXEOXGT.js";
 import {
   createWalkTreeSnapshot
 } from "./72E5EPFF.js";
+import {
+  prependHiddenDismiss
+} from "./6GXEOXGT.js";
 import {
   useFocusableContainer
 } from "./HPP6CWMY.js";

package/esm/__chunks/{EPBRINPG.js → QWSZGSIG.js}

@@ -6,10 +6,10 @@ import {
 } from "./YMV43K4F.js";
 import {
   usePopover
-} from "./A6XC27R5.js";
+} from "./IRX7SFUJ.js";
 import {
   createDialogComponent
-} from "./PGAEII2Q.js";
+} from "./NERBASET.js";
 import {
   HovercardScopedContextProvider,
   useHovercardProviderContext

package/esm/button/button.d.ts

@@ -18,7 +18,7 @@ export declare const useButton: import("../utils/types.js").Hook<ButtonOptions<"
  * @see https://ariakit.org/components/button
  * @example
  * ```jsx
- * <Button render={<div />}>Accessible button</Button>
+ * <Button>Button</Button>
  * ```
  */
 export declare const Button: import("../utils/types.js").Component<ButtonOptions<"button">>;

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

@@ -12,7 +12,14 @@ import type { CheckboxStore } from "./checkbox-store.js";
  */
 export declare const useCheckboxCheck: import("../utils/types.js").Hook<CheckboxCheckOptions<"span">>;
 /**
- * Renders a check mark icon, usually inside a `Checkbox` component.
+ * Renders a checkmark icon when the
+ * [`checked`](https://ariakit.org/reference/checkbox-check#checked) prop is
+ * `true`. The icon can be overridden by providing a different one as children.
+ *
+ * When rendered inside a [`Checkbox`](https://ariakit.org/reference/checkbox)
+ * component, the
+ * [`checked`](https://ariakit.org/reference/checkbox-check#checked) prop is
+ * automatically derived from the context.
  * @see https://ariakit.org/components/checkbox
  * @example
  * ```jsx
@@ -22,18 +29,19 @@ export declare const useCheckboxCheck: import("../utils/types.js").Hook<Checkbox
 export declare const CheckboxCheck: import("../utils/types.js").Component<CheckboxCheckOptions<"span">>;
 export interface CheckboxCheckOptions<T extends As = "span"> extends Options<T> {
     /**
-     * Object returned by the `useCheckboxStore` hook. If not provided, the parent
-     * `Checkbox` component's context will be used. If the `checked` prop is
-     * provided, it will override this prop.
+     * Object returned by the
+     * [`useCheckboxStore`](https://ariakit.org/reference/use-checkbox-store)
+     * hook.
      */
     store?: CheckboxStore;
     /**
-     * Determines if the check mark should be displayed. This value is
-     * automatically derived from the
-     * [`store`](https://ariakit.org/reference/checkbox-check#store) prop or the
-     * parent [`Checkbox`](https://ariakit.org/reference/checkbox) component.
+     * Determines if the checkmark should be rendered. This value is automatically
+     * derived from the context when it exists. Manually setting this prop will
+     * supersede the derived value.
      *
-     * Manually setting this prop will supersede the derived value.
+     * Live examples:
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
     checked?: boolean;
 }

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,10 +1,10 @@
 "use client";
-import {
-  CheckboxContextProvider
-} from "../__chunks/VPR2WHQV.js";
 import {
   useCheckboxStore
 } from "../__chunks/JIZ5C2JK.js";
+import {
+  CheckboxContextProvider
+} from "../__chunks/VPR2WHQV.js";
 import "../__chunks/3ORBWXWF.js";
 import "../__chunks/EKQEJRUF.js";
 import "../__chunks/6O5OEQGF.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.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/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
@@ -33,14 +35,27 @@ export interface CollectionItemOptions<T extends As = "div"> extends Options<T>
     /**
      * 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/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)
@@ -48,13 +63,12 @@ export interface CollectionItemOptions<T extends As = "div"> extends Options<T>
      */
     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-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-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.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-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-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;
 }