@ariakit/react-core 0.3.12 → 0.3.14

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

@@ -3,11 +3,13 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreStat
 import type { Store } from "../utils/store.js";
 export declare function useRadioStoreProps<T extends Core.RadioStore>(store: T, update: () => void, props: RadioStoreProps): T;
 /**
- * Creates a radio store.
+ * Creates a radio store to control the state of
+ * [Radio](https://ariakit.org/components/radio) components.
  * @see https://ariakit.org/components/radio
  * @example
  * ```jsx
  * const radio = useRadioStore();
+ *
  * <RadioGroup store={radio}>
  *   <Radio value="Apple" />
  *   <Radio value="Orange" />
@@ -21,7 +23,9 @@ export interface RadioStoreFunctions extends Core.RadioStoreFunctions, Composite
 }
 export interface RadioStoreOptions extends Core.RadioStoreOptions, CompositeStoreOptions {
     /**
-     * Function that will be called when the `value` state changes.
+     * Function that will be called when the
+     * [`value`](https://ariakit.org/reference/radio-provider#value) state
+     * changes.
      */
     setValue?: (value: RadioStoreState["value"]) => void;
 }

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

@@ -3,11 +3,13 @@ import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreStat
 import type { Store } from "../utils/store.js";
 export declare function useRadioStoreProps<T extends Core.RadioStore>(store: T, update: () => void, props: RadioStoreProps): T;
 /**
- * Creates a radio store.
+ * Creates a radio store to control the state of
+ * [Radio](https://ariakit.org/components/radio) components.
  * @see https://ariakit.org/components/radio
  * @example
  * ```jsx
  * const radio = useRadioStore();
+ *
  * <RadioGroup store={radio}>
  *   <Radio value="Apple" />
  *   <Radio value="Orange" />
@@ -21,7 +23,9 @@ export interface RadioStoreFunctions extends Core.RadioStoreFunctions, Composite
 }
 export interface RadioStoreOptions extends Core.RadioStoreOptions, CompositeStoreOptions {
     /**
-     * Function that will be called when the `value` state changes.
+     * Function that will be called when the
+     * [`value`](https://ariakit.org/reference/radio-provider#value) state
+     * changes.
      */
     setValue?: (value: RadioStoreState["value"]) => void;
 }

package/cjs/radio/radio.d.cts

@@ -18,15 +18,17 @@ import type { RadioStore } from "./radio-store.js";
  */
 export declare const useRadio: import("../utils/types.js").Hook<RadioOptions<"input">>;
 /**
- * Renders a radio button element.
+ * Renders a radio button element that's typically wrapped in a
+ * [`RadioGroup`](https://ariakit.org/reference/radio-group) component.
  * @see https://ariakit.org/components/radio
  * @example
- * ```jsx
- * const radio = useRadioStore();
- * <RadioGroup store={radio}>
- *   <Radio value="Apple" />
- *   <Radio value="Orange" />
- * </RadioGroup>
+ * ```jsx {3-4}
+ * <RadioProvider>
+ *   <RadioGroup>
+ *     <Radio value="Apple" />
+ *     <Radio value="Orange" />
+ *   </RadioGroup>
+ * </RadioProvider>
  * ```
  */
 export declare const Radio: import("../utils/types.js").Component<RadioOptions<"input">>;
@@ -40,20 +42,26 @@ export interface RadioOptions<T extends As = "input"> extends CompositeItemOptio
      * context will be used.
      */
     store?: RadioStore;
-    /**
-     * The native `name` attribute.
-     */
-    name?: string;
     /**
      * The value of the radio button.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      */
     value: string | number;
     /**
-     * Whether the radio button is checked.
+     * The native `name` attribute.
+     */
+    name?: string;
+    /**
+     * Determines if the radio button is checked. Using this prop will make the
+     * radio button controlled and override the
+     * [`value`](https://ariakit.org/reference/radio-provider#value) state.
      */
     checked?: boolean;
     /**
-     * Callback function that is called when the radio button store changes.
+     * Callback function that is called when the radio button state changes.
      */
     onChange?: BivariantCallback<(event: SyntheticEvent<HTMLInputElement>) => void>;
 }

package/cjs/radio/radio.d.ts

@@ -18,15 +18,17 @@ import type { RadioStore } from "./radio-store.js";
  */
 export declare const useRadio: import("../utils/types.js").Hook<RadioOptions<"input">>;
 /**
- * Renders a radio button element.
+ * Renders a radio button element that's typically wrapped in a
+ * [`RadioGroup`](https://ariakit.org/reference/radio-group) component.
  * @see https://ariakit.org/components/radio
  * @example
- * ```jsx
- * const radio = useRadioStore();
- * <RadioGroup store={radio}>
- *   <Radio value="Apple" />
- *   <Radio value="Orange" />
- * </RadioGroup>
+ * ```jsx {3-4}
+ * <RadioProvider>
+ *   <RadioGroup>
+ *     <Radio value="Apple" />
+ *     <Radio value="Orange" />
+ *   </RadioGroup>
+ * </RadioProvider>
  * ```
  */
 export declare const Radio: import("../utils/types.js").Component<RadioOptions<"input">>;
@@ -40,20 +42,26 @@ export interface RadioOptions<T extends As = "input"> extends CompositeItemOptio
      * context will be used.
      */
     store?: RadioStore;
-    /**
-     * The native `name` attribute.
-     */
-    name?: string;
     /**
      * The value of the radio button.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      */
     value: string | number;
     /**
-     * Whether the radio button is checked.
+     * The native `name` attribute.
+     */
+    name?: string;
+    /**
+     * Determines if the radio button is checked. Using this prop will make the
+     * radio button controlled and override the
+     * [`value`](https://ariakit.org/reference/radio-provider#value) state.
      */
     checked?: boolean;
     /**
-     * Callback function that is called when the radio button store changes.
+     * Callback function that is called when the radio button state changes.
      */
     onChange?: BivariantCallback<(event: SyntheticEvent<HTMLInputElement>) => void>;
 }

package/cjs/role/role.d.cts

@@ -14,9 +14,9 @@ type RoleElements = {
  */
 export declare const useRole: import("../utils/types.js").Hook<RoleOptions<"div">>;
 /**
- * Renders an abstract element that supports the `render` prop a `wrapElement`
- * prop that can be used to wrap the underlying element with React Portal,
- * Context or other component types.
+ * Renders an abstract element that supports the `render` prop and a
+ * `wrapElement` prop that can be used to wrap the underlying element with React
+ * Portal, Context or other component types.
  * @see https://ariakit.org/components/role
  * @example
  * ```jsx

package/cjs/role/role.d.ts

@@ -14,9 +14,9 @@ type RoleElements = {
  */
 export declare const useRole: import("../utils/types.js").Hook<RoleOptions<"div">>;
 /**
- * Renders an abstract element that supports the `render` prop a `wrapElement`
- * prop that can be used to wrap the underlying element with React Portal,
- * Context or other component types.
+ * Renders an abstract element that supports the `render` prop and a
+ * `wrapElement` prop that can be used to wrap the underlying element with React
+ * Portal, Context or other component types.
  * @see https://ariakit.org/components/role
  * @example
  * ```jsx

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

@@ -16,8 +16,8 @@ import type { SelectStore } from "./select-store.js";
 export declare const useSelectGroupLabel: import("../utils/types.js").Hook<SelectGroupLabelOptions<"div">>;
 /**
  * Renders a label in a select group. This component must be wrapped with
- * `SelectGroup` so the `aria-labelledby` prop is properly set on the select
- * group element.
+ * [`SelectGroup`](https://ariakit.org/reference/select-group) so the
+ * `aria-labelledby` prop is properly set on the select group element.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5,10}

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

@@ -16,8 +16,8 @@ import type { SelectStore } from "./select-store.js";
 export declare const useSelectGroupLabel: import("../utils/types.js").Hook<SelectGroupLabelOptions<"div">>;
 /**
  * Renders a label in a select group. This component must be wrapped with
- * `SelectGroup` so the `aria-labelledby` prop is properly set on the select
- * group element.
+ * [`SelectGroup`](https://ariakit.org/reference/select-group) so the
+ * `aria-labelledby` prop is properly set on the select group element.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5,10}

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

@@ -20,7 +20,10 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectGroup: import("../utils/types.js").Hook<SelectGroupOptions<"div">>;
 /**
- * Renders a select group.
+ * Renders a group for [`SelectItem`](https://ariakit.org/reference/select-item)
+ * elements. Optionally, a
+ * [`SelectGroupLabel`](https://ariakit.org/reference/select-group-label) can be
+ * rendered as a child to provide a label for the group.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {4-8}

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

@@ -20,7 +20,10 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectGroup: import("../utils/types.js").Hook<SelectGroupOptions<"div">>;
 /**
- * Renders a select group.
+ * Renders a group for [`SelectItem`](https://ariakit.org/reference/select-item)
+ * elements. Optionally, a
+ * [`SelectGroupLabel`](https://ariakit.org/reference/select-group-label) can be
+ * rendered as a child to provide a label for the group.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {4-8}

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

@@ -14,9 +14,14 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectItemCheck: import("../utils/types.js").Hook<SelectItemCheckOptions<"span">>;
 /**
- * Renders a checkmark inside a `SelectItem` component. This component must be
- * wrapped with `SelectItem` or the `checked` prop must be explicitly passed to
- * the component.
+ * Renders a checkmark icon when the
+ * [`checked`](https://ariakit.org/reference/select-item-check#checked) prop is
+ * `true`. The icon can be overridden by providing a different one as children.
+ *
+ * When rendered inside a
+ * [`SelectItem`](https://ariakit.org/reference/select-item) component, the
+ * [`checked`](https://ariakit.org/reference/select-item-check#checked) prop is
+ * automatically derived from the context.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5,9}
@@ -39,19 +44,8 @@ export declare const SelectItemCheck: import("../utils/types.js").Component<Sele
 export interface SelectItemCheckOptions<T extends As = "span"> extends CheckboxCheckOptions<T> {
     /**
      * Object returned by the
-     * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook. If
-     * not provided, the parent
-     * [`SelectList`](https://ariakit.org/reference/select-list) or
-     * [`SelectPopover`](https://ariakit.org/reference/select-popover) components'
-     * context will be used.
+     * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook.
      */
     store?: SelectStore;
-    /**
-     * Whether the check mark should be shown. This value is automatically
-     * inferred from the parent
-     * [`SelectItem`](https://ariakit.org/reference/select-item) component.
-     * Manually setting this prop will override the inferred value.
-     */
-    checked?: boolean;
 }
 export type SelectItemCheckProps<T extends As = "span"> = Props<SelectItemCheckOptions<T>>;

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

@@ -14,9 +14,14 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectItemCheck: import("../utils/types.js").Hook<SelectItemCheckOptions<"span">>;
 /**
- * Renders a checkmark inside a `SelectItem` component. This component must be
- * wrapped with `SelectItem` or the `checked` prop must be explicitly passed to
- * the component.
+ * Renders a checkmark icon when the
+ * [`checked`](https://ariakit.org/reference/select-item-check#checked) prop is
+ * `true`. The icon can be overridden by providing a different one as children.
+ *
+ * When rendered inside a
+ * [`SelectItem`](https://ariakit.org/reference/select-item) component, the
+ * [`checked`](https://ariakit.org/reference/select-item-check#checked) prop is
+ * automatically derived from the context.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5,9}
@@ -39,19 +44,8 @@ export declare const SelectItemCheck: import("../utils/types.js").Component<Sele
 export interface SelectItemCheckOptions<T extends As = "span"> extends CheckboxCheckOptions<T> {
     /**
      * Object returned by the
-     * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook. If
-     * not provided, the parent
-     * [`SelectList`](https://ariakit.org/reference/select-list) or
-     * [`SelectPopover`](https://ariakit.org/reference/select-popover) components'
-     * context will be used.
+     * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook.
      */
     store?: SelectStore;
-    /**
-     * Whether the check mark should be shown. This value is automatically
-     * inferred from the parent
-     * [`SelectItem`](https://ariakit.org/reference/select-item) component.
-     * Manually setting this prop will override the inferred value.
-     */
-    checked?: boolean;
 }
 export type SelectItemCheckProps<T extends As = "span"> = Props<SelectItemCheckOptions<T>>;

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

@@ -70,7 +70,7 @@ export interface SelectItemOptions<T extends As = "div"> extends CompositeItemOp
      * - [Form with Select](https://ariakit.org/examples/form-select)
      * - [Animated Select](https://ariakit.org/examples/select-animated)
      * - [Select with Combobox](https://ariakit.org/examples/select-combobox)
-     * - [Select grid](https://ariakit.org/examples/select-grid)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
      * - [SelectGroup](https://ariakit.org/examples/select-group)
      * - [Select with custom
      *   item](https://ariakit.org/examples/select-item-custom)
@@ -93,9 +93,5 @@ export interface SelectItemOptions<T extends As = "div"> extends CompositeItemOp
      * provided.
      */
     setValueOnClick?: BooleanOrCallback<MouseEvent<HTMLElement>>;
-    /**
-     * @default true
-     */
-    preventScrollOnKeyDown?: CompositeItemOptions["preventScrollOnKeyDown"];
 }
 export type SelectItemProps<T extends As = "div"> = Props<SelectItemOptions<T>>;

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

@@ -70,7 +70,7 @@ export interface SelectItemOptions<T extends As = "div"> extends CompositeItemOp
      * - [Form with Select](https://ariakit.org/examples/form-select)
      * - [Animated Select](https://ariakit.org/examples/select-animated)
      * - [Select with Combobox](https://ariakit.org/examples/select-combobox)
-     * - [Select grid](https://ariakit.org/examples/select-grid)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
      * - [SelectGroup](https://ariakit.org/examples/select-group)
      * - [Select with custom
      *   item](https://ariakit.org/examples/select-item-custom)
@@ -93,9 +93,5 @@ export interface SelectItemOptions<T extends As = "div"> extends CompositeItemOp
      * provided.
      */
     setValueOnClick?: BooleanOrCallback<MouseEvent<HTMLElement>>;
-    /**
-     * @default true
-     */
-    preventScrollOnKeyDown?: CompositeItemOptions["preventScrollOnKeyDown"];
 }
 export type SelectItemProps<T extends As = "div"> = Props<SelectItemOptions<T>>;

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

@@ -20,11 +20,14 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectList: import("../utils/types.js").Hook<SelectListOptions<"div">>;
 /**
- * Renders a select list. The `role` attribute is set to `listbox` by default,
- * but can be overriden by any other valid select popup role (`listbox`, `menu`,
- * `tree`, `grid` or `dialog`).
+ * Renders a select list element. This is the primitive component used by the
+ * [`SelectPopover`](https://ariakit.org/reference/select-popover) component.
  *
- * The `aria-labelledby` attribute is set to the
+ * Unlike [`SelectPopover`](https://ariakit.org/reference/select-popover), this
+ * component doesn't render a popover and therefore doesn't automatically focus
+ * on items when opened.
+ *
+ * The `aria-labelledby` prop is set to the
  * [`Select`](https://ariakit.org/reference/select) element's `id` by default.
  * @see https://ariakit.org/components/select
  * @example

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

@@ -20,11 +20,14 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectList: import("../utils/types.js").Hook<SelectListOptions<"div">>;
 /**
- * Renders a select list. The `role` attribute is set to `listbox` by default,
- * but can be overriden by any other valid select popup role (`listbox`, `menu`,
- * `tree`, `grid` or `dialog`).
+ * Renders a select list element. This is the primitive component used by the
+ * [`SelectPopover`](https://ariakit.org/reference/select-popover) component.
  *
- * The `aria-labelledby` attribute is set to the
+ * Unlike [`SelectPopover`](https://ariakit.org/reference/select-popover), this
+ * component doesn't render a popover and therefore doesn't automatically focus
+ * on items when opened.
+ *
+ * The `aria-labelledby` prop is set to the
  * [`Select`](https://ariakit.org/reference/select) element's `id` by default.
  * @see https://ariakit.org/components/select
  * @example

package/cjs/select/select-popover.cjs

@@ -12,12 +12,12 @@ require('../__chunks/UZNYSPKP.cjs');
 require('../__chunks/BZTDJIVT.cjs');
 
 
-var _KDG57VZVcjs = require('../__chunks/KDG57VZV.cjs');
+var _OUEE5HOScjs = 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');
@@ -25,11 +25,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');
@@ -66,11 +66,11 @@ var useSelectPopover = _RNZNGEL4cjs.createHook.call(void 0,
     const context = _2WCJJQSKcjs.useSelectProviderContext.call(void 0, );
     store = store || context;
     props = _XA62Y24Zcjs.useSelectList.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, { store, alwaysVisible }, props));
-    props = _KDG57VZVcjs.usePopover.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, { store, alwaysVisible }, props));
+    props = _OUEE5HOScjs.usePopover.call(void 0, _AV6KTKLEcjs.__spreadValues.call(void 0, { store, alwaysVisible }, props));
     return props;
   }
 );
-var SelectPopover = _EKB76T2Ucjs.createDialogComponent.call(void 0, 
+var SelectPopover = _ZL5DC555cjs.createDialogComponent.call(void 0, 
   _RNZNGEL4cjs.createComponent.call(void 0, (props) => {
     const htmlProps = useSelectPopover(props);
     return _RNZNGEL4cjs.createElement.call(void 0, "div", htmlProps);

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

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

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

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

package/cjs/select/select-renderer.d.cts

@@ -18,7 +18,7 @@ export interface SelectRendererOptions<T extends Item = any> extends Omit<Compos
     /**
      * Object returned by the
      * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook. If
-     * not provided, the parent [Select](https://ariakit.org/components/select)
+     * not provided, the closest [Select](https://ariakit.org/components/select)
      * component's context will be used.
      *
      * The store [`items`](https://ariakit.org/reference/use-select-store#items)

package/cjs/select/select-renderer.d.ts

@@ -18,7 +18,7 @@ export interface SelectRendererOptions<T extends Item = any> extends Omit<Compos
     /**
      * Object returned by the
      * [`useSelectStore`](https://ariakit.org/reference/use-select-store) hook. If
-     * not provided, the parent [Select](https://ariakit.org/components/select)
+     * not provided, the closest [Select](https://ariakit.org/components/select)
      * component's context will be used.
      *
      * The store [`items`](https://ariakit.org/reference/use-select-store#items)

package/cjs/select/select-row.d.cts

@@ -18,7 +18,10 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectRow: import("../utils/types.js").Hook<SelectRowOptions<"div">>;
 /**
- * Renders a select row.
+ * Renders a select row that allows two-dimensional arrow key navigation.
+ * [`SelectItem`](https://ariakit.org/reference/select-item) elements wrapped
+ * within this component will automatically receive a
+ * [`rowId`](https://ariakit.org/reference/select-item#rowid) prop.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {4-11}

package/cjs/select/select-row.d.ts

@@ -18,7 +18,10 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectRow: import("../utils/types.js").Hook<SelectRowOptions<"div">>;
 /**
- * Renders a select row.
+ * Renders a select row that allows two-dimensional arrow key navigation.
+ * [`SelectItem`](https://ariakit.org/reference/select-item) elements wrapped
+ * within this component will automatically receive a
+ * [`rowId`](https://ariakit.org/reference/select-item#rowid) prop.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {4-11}

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

@@ -18,7 +18,8 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectSeparator: import("../utils/types.js").Hook<SelectSeparatorOptions<"hr">>;
 /**
- * Renders a separator element for select items.
+ * Renders a divider between
+ * [`SelectItem`](https://ariakit.org/reference/select-item) elements.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5}

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

@@ -18,7 +18,8 @@ import type { SelectStore } from "./select-store.js";
  */
 export declare const useSelectSeparator: import("../utils/types.js").Hook<SelectSeparatorOptions<"hr">>;
 /**
- * Renders a separator element for select items.
+ * Renders a divider between
+ * [`SelectItem`](https://ariakit.org/reference/select-item) elements.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx {5}

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

@@ -8,11 +8,13 @@ export declare function useSelectStoreProps<T extends Core.SelectStore>(store: T
     combobox: ComboboxStore<import("@ariakit/core/combobox/combobox-store").ComboboxStoreSelectedValue> | null | undefined;
 };
 /**
- * Creates a select store.
+ * Creates a select store to control the state of
+ * [Select](https://ariakit.org/components/select) components.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx
  * const select = useSelectStore({ defaultValue: "Apple" });
+ *
  * <Select store={select} />
  * <SelectPopover store={select}>
  *   <SelectItem value="Apple" />
@@ -31,18 +33,23 @@ export interface SelectStoreFunctions<T extends SelectStoreValue = SelectStoreVa
 }
 export interface SelectStoreOptions<T extends SelectStoreValue = SelectStoreValue> extends Core.SelectStoreOptions<T>, CompositeStoreOptions<SelectStoreItem>, PopoverStoreOptions {
     /**
-     * Function that will be called when the `value` state changes.
-     * @param value The new value.
+     * Function that will be called when the
+     * [`value`](https://ariakit.org/reference/select-provider#value) state
+     * changes.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
+     * - [Select with custom items](https://ariakit.org/examples/select-item-custom)
+     * - [Multi-Select](https://ariakit.org/examples/select-multiple)
+     * - [Toolbar with Select](https://ariakit.org/examples/toolbar-select)
      */
     setValue?: BivariantCallback<(value: SelectStoreState<T>["value"]) => void>;
     /**
-     * A reference to a combobox store. This is used when combining the combobox
-     * with a select (e.g., select with a search input). The stores will share the
-     * same state.
-     *
-     * Live examples:
-     * - [Multi-selectable
-     *   Combobox](https://ariakit.org/examples/combobox-multiple)
+     * A reference to a [combobox
+     * store](https://ariakit.org/reference/use-combobox-store). It's
+     * automatically set when composing [Select with
+     * Combobox](https://ariakit.org/examples/select-combobox).
      */
     combobox?: ComboboxStore | null;
 }

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

@@ -8,11 +8,13 @@ export declare function useSelectStoreProps<T extends Core.SelectStore>(store: T
     combobox: ComboboxStore<import("@ariakit/core/combobox/combobox-store").ComboboxStoreSelectedValue> | null | undefined;
 };
 /**
- * Creates a select store.
+ * Creates a select store to control the state of
+ * [Select](https://ariakit.org/components/select) components.
  * @see https://ariakit.org/components/select
  * @example
  * ```jsx
  * const select = useSelectStore({ defaultValue: "Apple" });
+ *
  * <Select store={select} />
  * <SelectPopover store={select}>
  *   <SelectItem value="Apple" />
@@ -31,18 +33,23 @@ export interface SelectStoreFunctions<T extends SelectStoreValue = SelectStoreVa
 }
 export interface SelectStoreOptions<T extends SelectStoreValue = SelectStoreValue> extends Core.SelectStoreOptions<T>, CompositeStoreOptions<SelectStoreItem>, PopoverStoreOptions {
     /**
-     * Function that will be called when the `value` state changes.
-     * @param value The new value.
+     * Function that will be called when the
+     * [`value`](https://ariakit.org/reference/select-provider#value) state
+     * changes.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
+     * - [Select with custom items](https://ariakit.org/examples/select-item-custom)
+     * - [Multi-Select](https://ariakit.org/examples/select-multiple)
+     * - [Toolbar with Select](https://ariakit.org/examples/toolbar-select)
      */
     setValue?: BivariantCallback<(value: SelectStoreState<T>["value"]) => void>;
     /**
-     * A reference to a combobox store. This is used when combining the combobox
-     * with a select (e.g., select with a search input). The stores will share the
-     * same state.
-     *
-     * Live examples:
-     * - [Multi-selectable
-     *   Combobox](https://ariakit.org/examples/combobox-multiple)
+     * A reference to a [combobox
+     * store](https://ariakit.org/reference/use-combobox-store). It's
+     * automatically set when composing [Select with
+     * Combobox](https://ariakit.org/examples/select-combobox).
      */
     combobox?: ComboboxStore | null;
 }