@ariakit/core 0.3.9 → 0.3.11

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

@@ -19,6 +19,10 @@ export interface FormStoreItem extends CollectionStoreItem {
 export interface FormStoreState<T extends FormStoreValues = FormStoreValues> extends CollectionStoreState<FormStoreItem> {
     /**
      * Form values.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [FormSelect](https://ariakit.org/examples/form-select)
      * @default {}
      */
     values: T;
@@ -43,18 +47,25 @@ export interface FormStoreState<T extends FormStoreValues = FormStoreValues> ext
      */
     submitting: boolean;
     /**
-     * The number of times `form.submit` has been called with a successful
-     * response.
+     * The number of times
+     * [`submit`](https://ariakit.org/reference/use-form-store#submit) has been
+     * called with a successful response.
      */
     submitSucceed: number;
     /**
-     * The number of times `form.submit` has been called with an error response.
+     * The number of times
+     * [`submit`](https://ariakit.org/reference/use-form-store#submit) has been
+     * called with an error response.
      */
     submitFailed: number;
 }
 export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues> extends CollectionStoreFunctions<FormStoreItem> {
     /**
-     * An object containing the names of the form fields for type-safety.
+     * An object containing the names of the form fields for type safety.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [FormSelect](https://ariakit.org/examples/form-select)
      * @example
      * store.names.name; // "name"
      * store.names.name.first; // "name.first"
@@ -62,7 +73,8 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
      */
     names: Names<T>;
     /**
-     * Sets the `values` state.
+     * Sets the [`values`](https://ariakit.org/reference/form-provider#values)
+     * state.
      * @example
      * store.setValues({ name: "John" });
      * store.setValues((values) => ({ ...values, name: "John" }));
@@ -70,7 +82,9 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     setValues: SetState<FormStoreState<T>["values"]>;
     /**
      * Retrieves a field value.
-     * @param name The field name.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
      * @example
      * const nameValue = store.getValue("name");
      * // Can also use store.names for type-safety.
@@ -79,8 +93,9 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     getValue: <T = any>(name: StringLike) => T;
     /**
      * Sets a field value.
-     * @param name The field name.
-     * @param value The field value.
+     *
+     * Live examples:
+     * - [FormSelect](https://ariakit.org/examples/form-select)
      * @example
      * store.setValue("name", "John");
      * store.setValue("name", (value) => value + " Doe");
@@ -90,8 +105,6 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     setValue: <T>(name: StringLike, value: SetStateAction<T>) => void;
     /**
      * Pushes a value to an array field.
-     * @param name The array field name.
-     * @param value The value to push.
      * @example
      * store.pushValue("tags", "new tag");
      * store.pushValue("tags", { id: 1, name: "new tag" });
@@ -101,8 +114,6 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     pushValue: <T>(name: StringLike, value: T) => void;
     /**
      * Removes a value from an array field.
-     * @param name The array field name.
-     * @param index The index of the value to remove.
      * @example
      * store.removeValue("tags", 0);
      * store.removeValue("tags", 1);
@@ -111,7 +122,8 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
      */
     removeValue: (name: StringLike, index: number) => void;
     /**
-     * Sets the `errors` state.
+     * Sets the [`errors`](https://ariakit.org/reference/form-provider#errors)
+     * state.
      * @example
      * store.setErrors({ name: "Name is required" });
      * store.setErrors((errors) => ({ ...errors, name: "Name is required" }));
@@ -119,7 +131,6 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     setErrors: SetState<FormStoreState<T>["errors"]>;
     /**
      * Retrieves a field error.
-     * @param name The field name.
      * @example
      * const nameError = store.getError("name");
      * // Can also use store.names for type-safety.
@@ -128,8 +139,9 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     getError: (name: StringLike) => ErrorMessage;
     /**
      * Sets a field error.
-     * @param name The field name.
-     * @param error The field error.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
      * @example
      * store.setError("name", "Name is required");
      * store.setError("name", (error) => error + "!");
@@ -138,7 +150,8 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
      */
     setError: (name: StringLike, error: SetStateAction<ErrorMessage>) => void;
     /**
-     * Sets the `touched` state.
+     * Sets the [`touched`](https://ariakit.org/reference/form-provider#touched)
+     * state.
      * @example
      * store.setTouched({ name: true });
      * store.setTouched((touched) => ({ ...touched, name: true }));
@@ -146,7 +159,6 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     setTouched: SetState<FormStoreState<T>["touched"]>;
     /**
      * Retrieves a field touched state.
-     * @param name The field name.
      * @example
      * const nameTouched = store.getFieldTouched("name");
      * // Can also use store.names for type-safety.
@@ -155,8 +167,6 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     getFieldTouched: (name: StringLike) => boolean;
     /**
      * Sets a field touched state.
-     * @param name The field name.
-     * @param value The field touched state.
      * @example
      * store.setFieldTouched("name", true);
      * store.setFieldTouched("name", (value) => !value);
@@ -166,9 +176,8 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     setFieldTouched: (name: StringLike, value: SetStateAction<boolean>) => void;
     /**
      * Function that accepts a callback that will be used to validate the form
-     * when `validate` is called. It returns a cleanup function that will remove
-     * the callback.
-     * @param callback The callback function.
+     * when [`validate`](https://ariakit.org/reference/use-form-store#validate) is
+     * called. It returns a cleanup function that will remove the callback.
      * @example
      * const cleanup = store.onValidate(async (state) => {
      *   const errors = await api.validate(state.values);
@@ -179,9 +188,9 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
      */
     onValidate: (callback: FormStoreCallback<FormStoreState<T>>) => void;
     /**
-     * Function that accepts a callback that will be used to submit the form
-     * when `submit` is called. It returns a cleanup function that will remove
-     * the callback.
+     * Function that accepts a callback that will be used to submit the form when
+     * [`submit`](https://ariakit.org/reference/use-form-store#submit) is called.
+     * It returns a cleanup function that will remove the callback.
      * @param callback The callback function.
      * @example
      * const cleanup = store.onSubmit(async (state) => {

package/esm/form/form-store.js

@@ -1,19 +1,19 @@
 "use client";
 import {
   createCollectionStore
-} from "../__chunks/TLN4ALYH.js";
+} from "../__chunks/22K762VQ.js";
 import {
   createStore,
   init,
   setup,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   applyState,
   defaultValue,
   isInteger,
   isObject
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import {
   __spreadProps,

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

@@ -12,14 +12,16 @@ export interface HovercardStoreState extends PopoverStoreState {
     placement: PopoverStoreState["placement"];
     /**
      * The amount of time in milliseconds to wait before showing and hiding the
-     * popover. To control the delay for showing and hiding separately, use
-     * `showTimeout` and `hideTimeout`.
+     * popup. To control the delay for showing and hiding separately, use
+     * [`showTimeout`](https://ariakit.org/reference/hovercard-provider#showtimeout)
+     * and
+     * [`hideTimeout`](https://ariakit.org/reference/hovercard-provider#hidetimeout).
      * @default 500
      */
     timeout: number;
     /**
-     * The amount of time in milliseconds to wait before **showing** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _showing_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
      *
      * Live examples:
@@ -29,16 +31,18 @@ export interface HovercardStoreState extends PopoverStoreState {
      */
     showTimeout?: number;
     /**
-     * The amount of time in milliseconds to wait before **hiding** the popover.
-     * It defaults to the value passed to
+     * The amount of time in milliseconds to wait before _hiding_ the popup. It
+     * defaults to the value passed to
      * [`timeout`](https://ariakit.org/reference/hovercard-provider#timeout).
      *
      * Live examples:
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     hideTimeout?: number;
     /**
-     * Whether the popover or an element inside it should be focused when it is
+     * Whether the popup or an element inside it should be focused when it is
      * shown.
      * @default false
      */
@@ -47,6 +51,9 @@ export interface HovercardStoreState extends PopoverStoreState {
 export interface HovercardStoreFunctions extends PopoverStoreFunctions {
     /**
      * Sets the `autoFocusOnShow` state.
+     *
+     * Live examples:
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      */
     setAutoFocusOnShow: SetState<HovercardStoreState["autoFocusOnShow"]>;
 }

package/esm/hovercard/hovercard-store.js

@@ -1,12 +1,12 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/T3DVYGXI.js";
-import "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
-import "../__chunks/A2J4XZ5T.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/SOLWE6E5.js";
+import "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   createHovercardStore

package/esm/menu/menu-bar-store.js

@@ -1,11 +1,11 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/EZ2TTBAQ.js";
-import "../__chunks/DLX2AS6C.js";
-import "../__chunks/TLN4ALYH.js";
-import "../__chunks/A2J4XZ5T.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/XU3EOSCU.js";
+import "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";
 import "../__chunks/4R3V3JGP.js";

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

@@ -13,10 +13,13 @@ export interface MenuStoreState<T extends MenuStoreValues = MenuStoreValues> ext
      */
     initialFocus: "container" | "first" | "last";
     /**
-     * A map of names and values that will be used by the `MenuItemCheckbox` and
-     * `MenuItemRadio` components.
+     * A map of names and values that will be used by the
+     * [`MenuItemCheckbox`](https://ariakit.org/reference/menu-item-checkbox) and
+     * [`MenuItemRadio`](https://ariakit.org/reference/menu-item-radio)
+     * components.
      *
      * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
@@ -42,7 +45,8 @@ export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues>
      */
     setInitialFocus: SetState<MenuStoreState<T>["initialFocus"]>;
     /**
-     * Sets the `values` state.
+     * Sets the [`values`](https://ariakit.org/reference/menu-provider#values)
+     * state.
      * @example
      * store.setValues({ watching: ["issues"] });
      * store.setValues((values) => ({ ...values, watching: ["issues"] }));
@@ -68,16 +72,21 @@ export interface MenuStoreOptions<T extends MenuStoreValues = MenuStoreValues> e
      */
     combobox?: ComboboxStore | null;
     /**
-     * A reference to a parent menu store. This should be used on nested menus.
+     * A reference to a parent menu store. This is used on nested menus.
      */
     parent?: MenuStore | null;
     /**
-     * A reference to a menu bar store. This should be used when rendering menus
-     * inside a menu bar.
+     * A reference to a menubar store. This is used when rendering menus inside a
+     * menubar.
      */
     menubar?: MenuBarStore | null;
     /**
-     * The default values for the `values` state.
+     * The default values for the
+     * [`values`](https://ariakit.org/reference/menu-provider#values) state.
+     *
+     * Live examples:
+     * - [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)
+     * - [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)
      * @default {}
      */
     defaultValues?: MenuStoreState<T>["values"];

package/esm/menu/menu-store.js

@@ -1,14 +1,14 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/T3DVYGXI.js";
-import "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
+} from "../__chunks/SOLWE6E5.js";
+import "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createCompositeStore
-} from "../__chunks/DLX2AS6C.js";
-import "../__chunks/TLN4ALYH.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
   createStore,
   mergeStore,
@@ -17,11 +17,11 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   applyState,
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";
 import {

package/esm/menubar/menubar-store.js

@@ -1,11 +1,11 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/EZ2TTBAQ.js";
-import "../__chunks/DLX2AS6C.js";
-import "../__chunks/TLN4ALYH.js";
-import "../__chunks/A2J4XZ5T.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/XU3EOSCU.js";
+import "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";
 import "../__chunks/4R3V3JGP.js";

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

@@ -10,10 +10,18 @@ export declare function createPopoverStore({ popover: otherPopover, ...props }?:
 export interface PopoverStoreState extends DialogStoreState {
     /**
      * The anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     anchorElement: HTMLElement | null;
     /**
      * The popover element that will render the placement attributes.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Responsive Popover](https://ariakit.org/examples/popover-responsive)
      */
     popoverElement: HTMLElement | null;
     /**
@@ -21,30 +29,42 @@ export interface PopoverStoreState extends DialogStoreState {
      */
     arrowElement: HTMLElement | null;
     /**
-     * The current temporary placement state of the popover. This may be different
-     * from the the `placement` state if the popover has needed to update its
-     * position on the fly.
+     * The current temporary position of the popover. This might differ from the
+     * [`placement`](https://ariakit.org/reference/popover-provider#placement)
+     * state if the popover has had to adjust its position dynamically.
+     *
+     * Live examples:
+     * - [Tooltip with Framer
+     *   Motion](https://ariakit.org/examples/tooltip-framer-motion)
      */
     currentPlacement: Placement;
     /**
      * The placement of the popover.
      *
      * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Submenu with
      *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
+     * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
+     * - [Standalone Popover](https://ariakit.org/examples/popover-standalone)
+     * - [Select Grid](https://ariakit.org/examples/select-grid)
      * @default "bottom"
      */
     placement: Placement;
     /**
-     * A symbol that's used to recompute the popover position when the `render`
-     * method is called.
+     * A symbol that's used to recompute the popover position when the
+     * [`render`](https://ariakit.org/reference/use-popover-store#render) method
+     * is called.
      */
     rendered: symbol;
 }
 export interface PopoverStoreFunctions extends DialogStoreFunctions {
     /**
      * Sets the anchor element.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     setAnchorElement: SetState<PopoverStoreState["anchorElement"]>;
     /**
@@ -59,6 +79,11 @@ export interface PopoverStoreFunctions extends DialogStoreFunctions {
      * A function that can be used to recompute the popover position. This is
      * useful when the popover anchor changes in a way that affects the popover
      * position.
+     *
+     * Live examples:
+     * - [Textarea with inline
+     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Selection Popover](https://ariakit.org/examples/popover-selection)
      */
     render: () => void;
 }

package/esm/popover/popover-store.js

@@ -1,11 +1,11 @@
 "use client";
 import {
   createPopoverStore
-} from "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
-import "../__chunks/A2J4XZ5T.js";
-import "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
+import "../__chunks/EAHJFCU4.js";
+import "../__chunks/Y3OOHFCN.js";
 import "../__chunks/4R3V3JGP.js";
 export {
   createPopoverStore

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

@@ -18,7 +18,8 @@ export interface RadioStoreState extends CompositeStoreState {
 }
 export interface RadioStoreFunctions extends CompositeStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
+     * state.
      * @example
      * store.setValue("apple");
      * store.setValue((value) => value === "apple" ? "orange" : "apple");

package/esm/radio/radio-store.js

@@ -1,14 +1,14 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/DLX2AS6C.js";
-import "../__chunks/TLN4ALYH.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
   createStore
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";
 import {

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

@@ -60,7 +60,8 @@ export interface SelectStoreState<T extends SelectStoreValue = SelectStoreValue>
 }
 export interface SelectStoreFunctions<T extends SelectStoreValue = SelectStoreValue> extends Pick<SelectStoreOptions<T>, "combobox">, CompositeStoreFunctions<SelectStoreItem>, PopoverStoreFunctions {
     /**
-     * Sets the `value` state.
+     * Sets the [`value`](https://ariakit.org/reference/select-provider#value)
+     * state.
      * @example
      * store.setValue("Apple");
      * store.setValue(["Apple", "Banana"]);

package/esm/select/select-store.js

@@ -1,13 +1,13 @@
 "use client";
 import {
   createPopoverStore
-} from "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
+} from "../__chunks/AF6IUUFN.js";
+import "../__chunks/SX2XFD6A.js";
+import "../__chunks/Z5IGYIPT.js";
 import {
   createCompositeStore
-} from "../__chunks/DLX2AS6C.js";
-import "../__chunks/TLN4ALYH.js";
+} from "../__chunks/IERTEJ3A.js";
+import "../__chunks/22K762VQ.js";
 import {
   batch,
   createStore,
@@ -16,10 +16,10 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import {
   toArray

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

@@ -10,13 +10,9 @@ export interface TabStorePanel extends CollectionStoreItem {
     tabId?: string | null;
 }
 export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
-    /**
-     * @default "horizontal"
-     */
+    /** @default "horizontal" */
     orientation: CompositeStoreState<TabStoreItem>["orientation"];
-    /**
-     * @default true
-     */
+    /** @default true */
     focusLoop: CompositeStoreState<TabStoreItem>["focusLoop"];
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
@@ -24,11 +20,13 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     selectedId: TabStoreState["activeId"];
     /**
-     * Whether the tab should be selected when it receives focus. If it's set to
-     * `false`, the tab will be selected only when it's clicked.
+     * Determines if the tab should be selected when it receives focus. If set to
+     * `false`, the tab will only be selected upon clicking, not when
+     * using arrow keys to shift focus.
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
@@ -38,11 +36,11 @@ export interface TabStoreState extends CompositeStoreState<TabStoreItem> {
 }
 export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem> {
     /**
-     * Sets the `selectedId` state without moving focus. If you want to move focus,
-     * use the `select` function instead.
-     *
-     * Live examples:
-     * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
+     * Sets the
+     * [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid) state
+     * without moving focus. If you want to move focus, use the
+     * [`select`](https://ariakit.org/reference/use-tab-store#select) function
+     * instead.
      * @example
      * // Selects the tab with id "tab-1"
      * store.setSelectedId("tab-1");
@@ -60,9 +58,13 @@ export interface TabStoreFunctions extends CompositeStoreFunctions<TabStoreItem>
     panels: CollectionStore<TabStorePanel>;
     /**
      * Selects the tab for the given id and moves focus to it. If you want to set
-     * the `selectedId` state without moving focus, use the `setSelectedId`
+     * the [`selectedId`](https://ariakit.org/reference/tab-provider#selectedid)
+     * state without moving focus, use the
+     * [`setSelectedId`](https://ariakit.org/reference/use-tab-store#setselectedid-1)
      * function instead.
-     * @param id The id of the tab to select.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      * @example
      * // Selects the tab with id "tab-1"
      * store.select("tab-1");
@@ -77,6 +79,9 @@ export interface TabStoreOptions extends StoreOptions<TabStoreState, "orientatio
     /**
      * The id of the tab whose panel is currently visible. If it's `undefined`, it
      * will be automatically set to the first enabled tab.
+     *
+     * Live examples:
+     * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
      */
     defaultSelectedId?: TabStoreState["selectedId"];
 }

package/esm/tab/tab-store.js

@@ -1,19 +1,19 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/DLX2AS6C.js";
+} from "../__chunks/IERTEJ3A.js";
 import {
   createCollectionStore
-} from "../__chunks/TLN4ALYH.js";
+} from "../__chunks/22K762VQ.js";
 import {
   batch,
   createStore,
   setup,
   sync
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/EAHJFCU4.js";
 import {
   defaultValue
-} from "../__chunks/I2VQ3XGR.js";
+} from "../__chunks/Y3OOHFCN.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";
 import {