@ariakit/core 0.3.8 → 0.3.10

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.
+     *
+     * 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,13 +1,13 @@
 "use client";
 import {
   createCollectionStore
-} from "../__chunks/HMQYEBKF.js";
+} from "../__chunks/MYUKSFP5.js";
 import {
   createStore,
   init,
   setup,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   applyState,
   defaultValue,

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

@@ -19,15 +19,19 @@ export interface HovercardStoreState extends PopoverStoreState {
     timeout: number;
     /**
      * The amount of time in milliseconds to wait before **showing** the popover.
-     * It defaults to the value passed to `timeout`.
+     * 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)
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
     showTimeout?: number;
     /**
      * The amount of time in milliseconds to wait before **hiding** the popover.
-     * It defaults to the value passed to `timeout`.
+     * 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)

package/esm/hovercard/hovercard-store.js

@@ -1,11 +1,11 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/T3DVYGXI.js";
-import "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
-import "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/QJ5CUA32.js";
+import "../__chunks/AKMSZ36N.js";
+import "../__chunks/25MEC56I.js";
+import "../__chunks/L5RYKTVQ.js";
+import "../__chunks/K6ELJFXN.js";
 import "../__chunks/I2VQ3XGR.js";
 import "../__chunks/4R3V3JGP.js";
 export {

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

@@ -1,10 +1,10 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/A2AGSVJO.js";
-import "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
-import "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/UUFF4PQ6.js";
+import "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
+import "../__chunks/K6ELJFXN.js";
 import "../__chunks/I2VQ3XGR.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";

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

@@ -15,6 +15,10 @@ export interface MenuStoreState<T extends MenuStoreValues = MenuStoreValues> ext
     /**
      * A map of names and values that will be used by the `MenuItemCheckbox` and
      * `MenuItemRadio` components.
+     *
+     * Live examples:
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
     values: T;
     /** @default "vertical" */
@@ -27,6 +31,10 @@ export interface MenuStoreState<T extends MenuStoreValues = MenuStoreValues> ext
 export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues> extends CompositeStoreFunctions, HovercardStoreFunctions, Pick<MenuStoreOptions, "combobox" | "parent" | "menubar"> {
     /**
      * Hides the menu and all its parent menus.
+     *
+     * Live examples:
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      */
     hideAll: () => void;
     /**
@@ -42,8 +50,10 @@ export interface MenuStoreFunctions<T extends MenuStoreValues = MenuStoreValues>
     setValues: SetState<MenuStoreState<T>["values"]>;
     /**
      * Sets a specific menu value.
-     * @param name The name.
-     * @param value The value.
+     *
+     * Live examples:
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      * @example
      * store.setValue("watching", ["issues"]);
      * store.setValue("watching", (value) => [...value, "issues"]);

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/QJ5CUA32.js";
+import "../__chunks/AKMSZ36N.js";
+import "../__chunks/25MEC56I.js";
+import "../__chunks/L5RYKTVQ.js";
 import {
   createCompositeStore
-} from "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
+} from "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
 import {
   createStore,
   mergeStore,
@@ -17,7 +17,7 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   applyState,
   defaultValue

package/esm/menubar/menubar-store.js

@@ -1,10 +1,10 @@
 "use client";
 import {
   createMenubarStore
-} from "../__chunks/A2AGSVJO.js";
-import "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
-import "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/UUFF4PQ6.js";
+import "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
+import "../__chunks/K6ELJFXN.js";
 import "../__chunks/I2VQ3XGR.js";
 import "../__chunks/DLOEKDPY.js";
 import "../__chunks/7PRQYBBV.js";

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

@@ -31,6 +31,8 @@ export interface PopoverStoreState extends DialogStoreState {
      *
      * Live examples:
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Submenu with
+     *   Combobox](https://ariakit.org/examples/menu-nested-combobox)
      * @default "bottom"
      */
     placement: Placement;

package/esm/popover/popover-store.js

@@ -1,10 +1,10 @@
 "use client";
 import {
   createPopoverStore
-} from "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
-import "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/AKMSZ36N.js";
+import "../__chunks/25MEC56I.js";
+import "../__chunks/L5RYKTVQ.js";
+import "../__chunks/K6ELJFXN.js";
 import "../__chunks/I2VQ3XGR.js";
 import "../__chunks/4R3V3JGP.js";
 export {

package/esm/radio/radio-store.js

@@ -1,11 +1,11 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
+} from "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
 import {
   createStore
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   defaultValue
 } from "../__chunks/I2VQ3XGR.js";

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/AKMSZ36N.js";
+import "../__chunks/25MEC56I.js";
+import "../__chunks/L5RYKTVQ.js";
 import {
   createCompositeStore
-} from "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
+} from "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
 import {
   batch,
   createStore,
@@ -16,7 +16,7 @@ import {
   setup,
   sync,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   defaultValue
 } from "../__chunks/I2VQ3XGR.js";

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

@@ -24,6 +24,7 @@ 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"];
     /**
@@ -38,8 +39,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.
+     * 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.
      *
      * Live examples:
      * - [Tab with React Router](https://ariakit.org/examples/tab-react-router)
@@ -60,9 +64,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 +85,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,16 +1,16 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/CTZ2GQIZ.js";
+} from "../__chunks/VEUNYQYR.js";
 import {
   createCollectionStore
-} from "../__chunks/HMQYEBKF.js";
+} from "../__chunks/MYUKSFP5.js";
 import {
   batch,
   createStore,
   setup,
   sync
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   defaultValue
 } from "../__chunks/I2VQ3XGR.js";

package/esm/toolbar/toolbar-store.js

@@ -1,9 +1,9 @@
 "use client";
 import {
   createCompositeStore
-} from "../__chunks/CTZ2GQIZ.js";
-import "../__chunks/HMQYEBKF.js";
-import "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/VEUNYQYR.js";
+import "../__chunks/MYUKSFP5.js";
+import "../__chunks/K6ELJFXN.js";
 import {
   defaultValue
 } from "../__chunks/I2VQ3XGR.js";

package/esm/tooltip/tooltip-store.js

@@ -1,13 +1,13 @@
 "use client";
 import {
   createHovercardStore
-} from "../__chunks/T3DVYGXI.js";
-import "../__chunks/J6JIOWCS.js";
-import "../__chunks/LT2OYWRD.js";
-import "../__chunks/NKLTHWCR.js";
+} from "../__chunks/QJ5CUA32.js";
+import "../__chunks/AKMSZ36N.js";
+import "../__chunks/25MEC56I.js";
+import "../__chunks/L5RYKTVQ.js";
 import {
   createStore
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import {
   defaultValue
 } from "../__chunks/I2VQ3XGR.js";

package/esm/utils/store.js

@@ -10,7 +10,7 @@ import {
   subscribe,
   sync,
   throwOnConflictingProps
-} from "../__chunks/A2J4XZ5T.js";
+} from "../__chunks/K6ELJFXN.js";
 import "../__chunks/I2VQ3XGR.js";
 import "../__chunks/4R3V3JGP.js";
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ariakit/core",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "Ariakit core",
   "sideEffects": false,
   "license": "MIT",