@ariakit/core 0.3.9 → 0.3.11

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

@@ -6,40 +6,38 @@ import type { SetState } from "../utils/types.js";
 export declare function createDisclosureStore(props?: DisclosureStoreProps): DisclosureStore;
 export interface DisclosureStoreState {
     /**
-     * The visibility state of the content.
+     * Whether the content is visible.
      *
      * Live examples:
+     * - [Combobox with links](https://ariakit.org/examples/combobox-links)
      * - [Dialog with React
      *   Router](https://ariakit.org/examples/dialog-react-router)
+     * - [Menu with Framer
+     *   Motion](https://ariakit.org/examples/menu-framer-motion)
+     * - [Lazy Popover](https://ariakit.org/examples/popover-lazy)
      * @default false
      */
     open: boolean;
     /**
-     * The mounted state of the content. If `animated` is `false` or not defined,
-     * this will be the same as `open`. Otherwise, it will wait for the animation
-     * to complete before becoming `false` so the content is not unmounted while
-     * animating.
+     * The mounted state usually matches the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) value.
+     * However, if the content element is animated, it waits for the animation to
+     * finish before turning `false`. This ensures the content element doesn't get
+     * unmounted during the animation.
      *
      * Live examples:
-     * - [Combobox with links](https://ariakit.org/examples/combobox-links)
-     * - [Textarea with inline
-     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Responsive Popover](https://ariakit.org/examples/popover-responsive)
      */
     mounted: boolean;
     /**
      * Determines whether the content should animate when it is shown or hidden.
      * - If `true`, the `animating` state will be `true` when the content is shown
-     *   or hidden and it will wait for `stopAnimation` to be called or a CSS
-     *   animation/transition to end before becoming `false`.
+     *   or hidden and it will wait for a CSS animation/transition to end before
+     *   becoming `false`.
      * - If it's set to a number, the `animating` state will be `true` when the
      *   content is shown or hidden and it will wait for the number of
      *   milliseconds to pass before becoming `false`.
-     *
-     * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
-     * - [Animated Combobox](https://ariakit.org/examples/combobox-animated)
-     * - [Animated Dialog](https://ariakit.org/examples/dialog-animated)
-     * - [Animated Select](https://ariakit.org/examples/select-animated)
      * @default false
      */
     animated: boolean | number;
@@ -58,46 +56,50 @@ export interface DisclosureStoreState {
 }
 export interface DisclosureStoreFunctions {
     /**
-     * Sets the `open` state.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state.
      *
      * Live examples:
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
-     * - [Dialog with React
-     *   Router](https://ariakit.org/examples/dialog-react-router)
      * @example
      * store.setOpen(true);
      * store.setOpen((open) => !open);
      */
     setOpen: SetState<DisclosureStoreState["open"]>;
     /**
-     * Sets the `open` state to `true`.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state to `true`.
      *
      * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Dialog with Framer
+     *   Motion](https://ariakit.org/examples/dialog-framer-motion)
+     * - [Context Menu](https://ariakit.org/examples/menu-context-menu)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     show: () => void;
     /**
-     * Sets the `open` state to `false`.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state to `false`.
      *
      * Live examples:
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
-     * - [Dialog with React
-     *   Router](https://ariakit.org/examples/dialog-react-router)
      * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      */
     hide: () => void;
     /**
-     * Toggles the `open` state.
+     * Toggles the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) state.
      */
     toggle: () => void;
     /**
      * Sets the `animating` state to `false`, which will automatically set the
      * `mounted` state to `false` if it was `true`. This means that the content
      * element can be safely unmounted.
+     * @deprecated Use `setState("animating", false)` instead.
      */
     stopAnimation: () => void;
     /**
@@ -106,19 +108,23 @@ export interface DisclosureStoreFunctions {
     setContentElement: SetState<DisclosureStoreState["contentElement"]>;
     /**
      * Sets the `disclosureElement` state.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     setDisclosureElement: SetState<DisclosureStoreState["disclosureElement"]>;
 }
 export interface DisclosureStoreOptions extends StoreOptions<DisclosureStoreState, "open" | "animated"> {
     /**
-     * The default visibility state of the content.
+     * Whether the content should be visible by default.
      * @default false
      */
     defaultOpen?: DisclosureStoreState["open"];
     /**
      * A reference to another disclosure store that controls another disclosure
      * component to keep them in sync. Element states like `contentElement` and
-     * `disclosureElement` won't be synced. For that, use the `store` prop
+     * `disclosureElement` won't be synced. For that, use the
+     * [`store`](https://ariakit.org/reference/disclosure-provider#store) prop
      * instead.
      */
     disclosure?: DisclosureStore | null;

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

@@ -6,40 +6,38 @@ import type { SetState } from "../utils/types.js";
 export declare function createDisclosureStore(props?: DisclosureStoreProps): DisclosureStore;
 export interface DisclosureStoreState {
     /**
-     * The visibility state of the content.
+     * Whether the content is visible.
      *
      * Live examples:
+     * - [Combobox with links](https://ariakit.org/examples/combobox-links)
      * - [Dialog with React
      *   Router](https://ariakit.org/examples/dialog-react-router)
+     * - [Menu with Framer
+     *   Motion](https://ariakit.org/examples/menu-framer-motion)
+     * - [Lazy Popover](https://ariakit.org/examples/popover-lazy)
      * @default false
      */
     open: boolean;
     /**
-     * The mounted state of the content. If `animated` is `false` or not defined,
-     * this will be the same as `open`. Otherwise, it will wait for the animation
-     * to complete before becoming `false` so the content is not unmounted while
-     * animating.
+     * The mounted state usually matches the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) value.
+     * However, if the content element is animated, it waits for the animation to
+     * finish before turning `false`. This ensures the content element doesn't get
+     * unmounted during the animation.
      *
      * Live examples:
-     * - [Combobox with links](https://ariakit.org/examples/combobox-links)
-     * - [Textarea with inline
-     *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
+     * - [Responsive Popover](https://ariakit.org/examples/popover-responsive)
      */
     mounted: boolean;
     /**
      * Determines whether the content should animate when it is shown or hidden.
      * - If `true`, the `animating` state will be `true` when the content is shown
-     *   or hidden and it will wait for `stopAnimation` to be called or a CSS
-     *   animation/transition to end before becoming `false`.
+     *   or hidden and it will wait for a CSS animation/transition to end before
+     *   becoming `false`.
      * - If it's set to a number, the `animating` state will be `true` when the
      *   content is shown or hidden and it will wait for the number of
      *   milliseconds to pass before becoming `false`.
-     *
-     * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
-     * - [Animated Combobox](https://ariakit.org/examples/combobox-animated)
-     * - [Animated Dialog](https://ariakit.org/examples/dialog-animated)
-     * - [Animated Select](https://ariakit.org/examples/select-animated)
      * @default false
      */
     animated: boolean | number;
@@ -58,46 +56,50 @@ export interface DisclosureStoreState {
 }
 export interface DisclosureStoreFunctions {
     /**
-     * Sets the `open` state.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state.
      *
      * Live examples:
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
-     * - [Dialog with React
-     *   Router](https://ariakit.org/examples/dialog-react-router)
      * @example
      * store.setOpen(true);
      * store.setOpen((open) => !open);
      */
     setOpen: SetState<DisclosureStoreState["open"]>;
     /**
-     * Sets the `open` state to `true`.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state to `true`.
      *
      * Live examples:
-     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
+     * - [Dialog with Framer
+     *   Motion](https://ariakit.org/examples/dialog-framer-motion)
+     * - [Context Menu](https://ariakit.org/examples/menu-context-menu)
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     show: () => void;
     /**
-     * Sets the `open` state to `false`.
+     * Sets the [`open`](https://ariakit.org/reference/disclosure-provider#open)
+     * state to `false`.
      *
      * Live examples:
      * - [Textarea with inline
      *   Combobox](https://ariakit.org/examples/combobox-textarea)
-     * - [Dialog with React
-     *   Router](https://ariakit.org/examples/dialog-react-router)
      * - [Sliding Menu](https://ariakit.org/examples/menu-slide)
      */
     hide: () => void;
     /**
-     * Toggles the `open` state.
+     * Toggles the
+     * [`open`](https://ariakit.org/reference/disclosure-provider#open) state.
      */
     toggle: () => void;
     /**
      * Sets the `animating` state to `false`, which will automatically set the
      * `mounted` state to `false` if it was `true`. This means that the content
      * element can be safely unmounted.
+     * @deprecated Use `setState("animating", false)` instead.
      */
     stopAnimation: () => void;
     /**
@@ -106,19 +108,23 @@ export interface DisclosureStoreFunctions {
     setContentElement: SetState<DisclosureStoreState["contentElement"]>;
     /**
      * Sets the `disclosureElement` state.
+     *
+     * Live examples:
+     * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)
      */
     setDisclosureElement: SetState<DisclosureStoreState["disclosureElement"]>;
 }
 export interface DisclosureStoreOptions extends StoreOptions<DisclosureStoreState, "open" | "animated"> {
     /**
-     * The default visibility state of the content.
+     * Whether the content should be visible by default.
      * @default false
      */
     defaultOpen?: DisclosureStoreState["open"];
     /**
      * A reference to another disclosure store that controls another disclosure
      * component to keep them in sync. Element states like `contentElement` and
-     * `disclosureElement` won't be synced. For that, use the `store` prop
+     * `disclosureElement` won't be synced. For that, use the
+     * [`store`](https://ariakit.org/reference/disclosure-provider#store) prop
      * instead.
      */
     disclosure?: DisclosureStore | null;

package/cjs/form/form-store.cjs

@@ -1,19 +1,19 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-var _UCLKUBNPcjs = require('../__chunks/UCLKUBNP.cjs');
+var _MI6NUQYQcjs = require('../__chunks/MI6NUQYQ.cjs');
 
 
 
 
 
-var _2UK5WUJXcjs = require('../__chunks/2UK5WUJX.cjs');
+var _F6HPKLO2cjs = require('../__chunks/F6HPKLO2.cjs');
 
 
 
 
 
-var _3UT5FE6Kcjs = require('../__chunks/3UT5FE6K.cjs');
+var _KBNYGXWIcjs = require('../__chunks/KBNYGXWI.cjs');
 require('../__chunks/5F4DVUNS.cjs');
 
 
@@ -26,7 +26,7 @@ function nextFrame() {
 }
 function hasMessages(object) {
   return Object.keys(object).some((key) => {
-    if (_3UT5FE6Kcjs.isObject.call(void 0, object[key])) {
+    if (_KBNYGXWIcjs.isObject.call(void 0, object[key])) {
       return hasMessages(object[key]);
     }
     return !!object[key];
@@ -48,10 +48,10 @@ function set(values, path, value) {
   if (k == null)
     return values;
   const key = k;
-  const isIntegerKey = _3UT5FE6Kcjs.isInteger.call(void 0, key);
+  const isIntegerKey = _KBNYGXWIcjs.isInteger.call(void 0, key);
   const nextValues = isIntegerKey ? values || [] : values || {};
   const nestedValues = nextValues[key];
-  const result = rest.length && (Array.isArray(nestedValues) || _3UT5FE6Kcjs.isObject.call(void 0, nestedValues)) ? set(nestedValues, rest, value) : value;
+  const result = rest.length && (Array.isArray(nestedValues) || _KBNYGXWIcjs.isObject.call(void 0, nestedValues)) ? set(nestedValues, rest, value) : value;
   if (isIntegerKey) {
     const index = Number(key);
     if (values && Array.isArray(values)) {
@@ -74,12 +74,12 @@ function setAll(values, value) {
     const currentValue = values[key];
     if (Array.isArray(currentValue)) {
       result[key] = currentValue.map((v) => {
-        if (_3UT5FE6Kcjs.isObject.call(void 0, v)) {
+        if (_KBNYGXWIcjs.isObject.call(void 0, v)) {
           return setAll(v, value);
         }
         return value;
       });
-    } else if (_3UT5FE6Kcjs.isObject.call(void 0, currentValue)) {
+    } else if (_KBNYGXWIcjs.isObject.call(void 0, currentValue)) {
       result[key] = setAll(currentValue, value);
     } else {
       result[key] = value;
@@ -114,22 +114,22 @@ function createNames() {
 }
 function createFormStore(props = {}) {
   var _a;
-  _2UK5WUJXcjs.throwOnConflictingProps.call(void 0, props, props.store);
+  _F6HPKLO2cjs.throwOnConflictingProps.call(void 0, props, props.store);
   const syncState = (_a = props.store) == null ? void 0 : _a.getState();
-  const collection = _UCLKUBNPcjs.createCollectionStore.call(void 0, props);
-  const values = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const collection = _MI6NUQYQcjs.createCollectionStore.call(void 0, props);
+  const values = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.values,
     syncState == null ? void 0 : syncState.values,
     props.defaultValues,
     {}
   );
-  const errors = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const errors = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.errors,
     syncState == null ? void 0 : syncState.errors,
     props.defaultErrors,
     {}
   );
-  const touched = _3UT5FE6Kcjs.defaultValue.call(void 0, 
+  const touched = _KBNYGXWIcjs.defaultValue.call(void 0, 
     props.touched,
     syncState == null ? void 0 : syncState.touched,
     props.defaultTouched,
@@ -139,21 +139,21 @@ function createFormStore(props = {}) {
     values,
     errors,
     touched,
-    validating: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.validating, false),
-    submitting: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitting, false),
-    submitSucceed: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitSucceed, 0),
-    submitFailed: _3UT5FE6Kcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitFailed, 0),
+    validating: _KBNYGXWIcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.validating, false),
+    submitting: _KBNYGXWIcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitting, false),
+    submitSucceed: _KBNYGXWIcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitSucceed, 0),
+    submitFailed: _KBNYGXWIcjs.defaultValue.call(void 0, syncState == null ? void 0 : syncState.submitFailed, 0),
     valid: !hasMessages(errors)
   });
-  const form = _2UK5WUJXcjs.createStore.call(void 0, initialState, collection, props.store);
+  const form = _F6HPKLO2cjs.createStore.call(void 0, initialState, collection, props.store);
   const syncCallbacks = getStoreCallbacks(props.store);
   const syncCallbacksState = syncCallbacks == null ? void 0 : syncCallbacks.getState();
   const callbacksInitialState = {
     validate: (syncCallbacksState == null ? void 0 : syncCallbacksState.validate) || [],
     submit: (syncCallbacksState == null ? void 0 : syncCallbacksState.submit) || []
   };
-  const callbacks = _2UK5WUJXcjs.createStore.call(void 0, callbacksInitialState, syncCallbacks);
-  _2UK5WUJXcjs.setup.call(void 0, form, () => _2UK5WUJXcjs.init.call(void 0, callbacks));
+  const callbacks = _F6HPKLO2cjs.createStore.call(void 0, callbacksInitialState, syncCallbacks);
+  _F6HPKLO2cjs.setup.call(void 0, form, () => _F6HPKLO2cjs.init.call(void 0, callbacks));
   const validate = async () => {
     form.setState("validating", true);
     form.setState("errors", {});
@@ -174,7 +174,7 @@ function createFormStore(props = {}) {
     getValue: (name) => get(form.getState().values, name),
     setValue: (name, value) => form.setState("values", (values2) => {
       const prevValue = get(values2, name);
-      const nextValue = _3UT5FE6Kcjs.applyState.call(void 0, value, prevValue);
+      const nextValue = _KBNYGXWIcjs.applyState.call(void 0, value, prevValue);
       if (nextValue === prevValue)
         return values2;
       return set(values2, name, nextValue);
@@ -195,7 +195,7 @@ function createFormStore(props = {}) {
     getError: (name) => get(form.getState().errors, name),
     setError: (name, error) => form.setState("errors", (errors2) => {
       const prevError = get(errors2, name);
-      const nextError = _3UT5FE6Kcjs.applyState.call(void 0, error, prevError);
+      const nextError = _KBNYGXWIcjs.applyState.call(void 0, error, prevError);
       if (nextError === prevError)
         return errors2;
       return set(errors2, name, nextError);
@@ -204,7 +204,7 @@ function createFormStore(props = {}) {
     getFieldTouched: (name) => !!get(form.getState().touched, name),
     setFieldTouched: (name, value) => form.setState("touched", (touched2) => {
       const prevValue = get(touched2, name);
-      const nextValue = _3UT5FE6Kcjs.applyState.call(void 0, value, prevValue);
+      const nextValue = _KBNYGXWIcjs.applyState.call(void 0, value, prevValue);
       if (nextValue === prevValue)
         return touched2;
       return set(touched2, name, nextValue);

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

@@ -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) => {