@ariakit/react-core 0.3.12 → 0.3.13

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

@@ -1,16 +1,12 @@
-import type { FocusEvent } from "react";
-import type { StringLike } from "@ariakit/core/form/types";
-import type { BooleanOrCallback } from "@ariakit/core/utils/types";
-import type { CollectionItemOptions } from "../collection/collection-item.js";
 import type { As, Props } from "../utils/types.js";
-import type { FormStore } from "./form-store.js";
+import type { FormControlOptions } from "./form-control.js";
 /**
  * Returns props to create a `FormField` component. Unlike `useFormInput`, this
  * hook doesn't automatically returns the `value` and `onChange` props. This is
  * so we can use it not only for native form elements but also for custom
  * components whose value is not controlled by the native `value` and `onChange`
  * props.
- * @see https://ariakit.org/components/form
+ * @deprecated Use `useFormControl` instead.
  * @example
  * ```jsx
  * const store = useFormStore({ defaultValues: { content: "" } });
@@ -30,15 +26,18 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormField: import("../utils/types.js").Hook<FormFieldOptions<"input">>;
 /**
- * Renders a form field. Unlike
+ * Abstract component that renders a form field. Unlike
  * [`FormInput`](https://ariakit.org/reference/form-input), this component
  * doesn't automatically pass the `value` and `onChange` props down to the
  * underlying element. This is so we can use it not only for native form
  * elements but also for custom components whose value is not controlled by the
  * native `value` and `onChange` props.
- * @see https://ariakit.org/components/form
+ * @deprecated
+ * This component has been renamed to
+ * [`FormControl`](https://ariakit.org/reference/form-control). The API remains
+ * the same.
  * @example
- * ```jsx
+ * ```jsx {11-19}
  * const form = useFormStore({
  *   defaultValues: {
  *     content: "",
@@ -50,31 +49,18 @@ export declare const useFormField: import("../utils/types.js").Hook<FormFieldOpt
  * <Form store={form}>
  *   <FormLabel name={form.names.content}>Content</FormLabel>
  *   <FormField
- *     value={value}
- *     onChange={(value) => form.setValue(form.names.content, value)}
- *     render={<Editor />}
+ *     name={form.names.content}
+ *     render={
+ *       <Editor
+ *         value={value}
+ *         onChange={(value) => form.setValue(form.names.content, value)}
+ *       />
+ *     }
  *   />
  * </Form>
  * ```
  */
 export declare const FormField: import("../utils/types.js").Component<FormFieldOptions<"input">>;
-export interface FormFieldOptions<T extends As = "input"> extends CollectionItemOptions<T> {
-    /**
-     * Object returned by the
-     * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
-     * provided, the closest [`Form`](https://ariakit.org/reference/form) or
-     * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
-     * context will be used.
-     */
-    store?: FormStore;
-    /**
-     * Name of the field.
-     */
-    name: StringLike;
-    /**
-     * Whether the field should be marked touched on blur.
-     * @default true
-     */
-    touchOnBlur?: BooleanOrCallback<FocusEvent>;
+export interface FormFieldOptions<T extends As = "input"> extends FormControlOptions<T> {
 }
 export type FormFieldProps<T extends As = "input"> = Props<FormFieldOptions<T>>;

package/esm/form/form-field.js

@@ -1,15 +1,30 @@
 "use client";
 import {
-  FormField,
-  useFormField
-} from "../__chunks/FS2EVEJO.js";
+  useFormControl
+} from "../__chunks/4GO43MST.js";
 import "../__chunks/V4ZFXDFK.js";
 import "../__chunks/UH3I23HL.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/3ORBWXWF.js";
+import {
+  createElement,
+  createHook,
+  createMemoComponent
+} from "../__chunks/3ORBWXWF.js";
 import "../__chunks/6O5OEQGF.js";
 import "../__chunks/XM66DUTO.js";
 import "../__chunks/4R3V3JGP.js";
+
+// src/form/form-field.ts
+var useFormField = createHook((props) => {
+  return useFormControl(props);
+});
+var FormField = createMemoComponent((props) => {
+  const htmlProps = useFormField(props);
+  return createElement("input", htmlProps);
+});
+if (process.env.NODE_ENV !== "production") {
+  FormField.displayName = "FormField";
+}
 export {
   FormField,
   useFormField

package/esm/form/form-group-label.d.ts

@@ -15,18 +15,20 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormGroupLabel: import("../utils/types.js").Hook<FormGroupLabelOptions<"div">>;
 /**
- * Renders a label in a form group. This component must be wrapped with
- * [`FormGroup`](https://ariakit.org/reference/form-group) so the
- * `aria-labelledby` prop is properly set on the form group element.
+ * Renders a label in a form group. This component must be wrapped with the
+ * [`FormGroup`](https://ariakit.org/reference/form-group) or
+ * [`FormRadioGroup`](https://ariakit.org/reference/form-radio-group) components
+ * so the `aria-labelledby` prop is properly set on the form group element.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {10}
  * const form = useFormStore({
  *   defaultValues: {
  *     username: "",
  *     email: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormGroup>
  *     <FormGroupLabel>Account</FormGroupLabel>

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

@@ -17,16 +17,20 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormGroup: import("../utils/types.js").Hook<FormGroupOptions<"div">>;
 /**
- * Renders a form group.
+ * Renders a group element for form controls. The
+ * [`FormGroupLabel`](https://ariakit.org/reference/form-group-label) component
+ * can be used inside this component so the `aria-labelledby` prop is properly
+ * set on the group element.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {9-15}
  * const form = useFormStore({
  *   defaultValues: {
  *     username: "",
  *     email: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormGroup>
  *     <FormGroupLabel>Account</FormGroupLabel>

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

@@ -1,8 +1,8 @@
 import type { FocusableOptions } from "../focusable/focusable.js";
 import type { As, Props } from "../utils/types.js";
-import type { FormFieldOptions } from "./form-field.js";
+import type { FormControlOptions } from "./form-control.js";
 /**
- * Returns props to create a `FormInput` component. Unlike `useFormField`, this
+ * Returns props to create a `FormInput` component. Unlike `useFormControl`, this
  * hook returns the `value` and `onChange` props that can be passed to a native
  * input, select or textarea elements.
  * @see https://ariakit.org/components/form
@@ -19,17 +19,18 @@ import type { FormFieldOptions } from "./form-field.js";
 export declare const useFormInput: import("../utils/types.js").Hook<FormInputOptions<"input">>;
 /**
  * Renders a form input. Unlike
- * [`FormField`](https://ariakit.org/reference/form-field), this component
+ * [`FormControl`](https://ariakit.org/reference/form-control), this component
  * passes the `value` and `onChange` props down to the underlying element that
- * can be a native input, select or textarea elements.
+ * can be native input, select or textarea elements.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {9}
  * const form = useFormStore({
  *   defaultValues: {
  *     email: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormLabel name={form.names.email}>Email</FormLabel>
  *   <FormInput name={form.names.email} />
@@ -37,6 +38,6 @@ export declare const useFormInput: import("../utils/types.js").Hook<FormInputOpt
  * ```
  */
 export declare const FormInput: import("../utils/types.js").Component<FormInputOptions<"input">>;
-export interface FormInputOptions<T extends As = "input"> extends FormFieldOptions<T>, FocusableOptions<T> {
+export interface FormInputOptions<T extends As = "input"> extends FormControlOptions<T>, FocusableOptions<T> {
 }
 export type FormInputProps<T extends As = "input"> = Props<FormInputOptions<T>>;

package/esm/form/form-input.js

@@ -1,7 +1,7 @@
 "use client";
 import {
-  useFormField
-} from "../__chunks/FS2EVEJO.js";
+  useFormControl
+} from "../__chunks/4GO43MST.js";
 import {
   useFormContext
 } from "../__chunks/V4ZFXDFK.js";
@@ -9,7 +9,7 @@ import "../__chunks/UH3I23HL.js";
 import "../__chunks/4UUKJZ4V.js";
 import {
   useFocusable
-} from "../__chunks/KK7H3W2B.js";
+} from "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createElement,
@@ -52,7 +52,7 @@ var useFormInput = createHook(
       onChange
     });
     props = useFocusable(props);
-    props = useFormField(__spreadValues({ store, name }, props));
+    props = useFormControl(__spreadValues({ store, name }, props));
     return props;
   }
 );

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

@@ -21,19 +21,23 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormLabel: import("../utils/types.js").Hook<FormLabelOptions<"label">>;
 /**
- * Renders a label for a form field. If the field is not a native input, select
- * or textarea element, the component will render a `span` element. Instead of
- * relying on the `htmlFor` prop, it'll rely on the `aria-labelledby` attribute
- * on the form field. Clicking on the label will move focus to the field even if
- * it's not a native input.
+ * Renders a label associated with a form field, even if the field is not a
+ * native input.
+ *
+ * If the field is a native input, select or textarea element, this component
+ * will render a native `label` element and rely on its `htmlFor` prop.
+ * Otherwise, it'll render a `span` element and rely on the `aria-labelledby`
+ * attribute on the form field instead. Clicking on the label will move focus to
+ * the field even if it's not a native input.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {8}
  * const form = useFormStore({
  *   defaultValues: {
  *     email: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormLabel name={form.names.email}>Email</Role>
  *   <FormInput name={form.names.email} />
@@ -51,7 +55,14 @@ export interface FormLabelOptions<T extends As = "label"> extends CollectionItem
      */
     store?: FormStore;
     /**
-     * Name of the field.
+     * Name of the field labeled by this element. This can either be a string or a
+     * reference to a field name from the
+     * [`names`](https://ariakit.org/reference/use-form-store#names) object in the
+     * store, for type safety.
+     * @example
+     * ```jsx
+     * <FormLabel name="email">Email</FormLabel>
+     * ```
      */
     name: StringLike;
 }

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

@@ -4,7 +4,8 @@ import type { PickRequired } from "@ariakit/core/utils/types";
 import type { FormStoreProps } from "./form-store.js";
 type Values = FormStoreValues;
 /**
- * Provides a form store to Form components.
+ * Provides a form store to [Form](https://ariakit.org/components/form)
+ * components.
  * @see https://ariakit.org/components/form
  * @example
  * ```jsx

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

@@ -32,14 +32,25 @@ export declare const useFormPush: import("../utils/types.js").Hook<FormPushOptio
 /**
  * Renders a button that will push items to an array value in the form store
  * when clicked.
+ *
+ * The [`name`](https://ariakit.org/reference/form-push#name) prop needs to be
+ * provided to identify the array field. The
+ * [`value`](https://ariakit.org/reference/form-push#value) prop is required to
+ * define the value that will be added to the array.
+ *
+ * By default, the newly added input will be automatically focused when the
+ * button is clicked unless the
+ * [`autoFocusOnClick`](https://ariakit.org/reference/form-push#autofocusonclick)
+ * prop is set to `false`.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {13-15}
  * const form = useFormStore({
  *   defaultValues: {
  *     languages: ["JavaScript", "PHP"],
  *   },
  * });
+ *
  * const values = form.useState("values");
  *
  * <Form store={form}>
@@ -63,11 +74,14 @@ export interface FormPushOptions<T extends As = "button"> extends ButtonOptions<
      */
     store?: FormStore;
     /**
-     * Name of the array field.
+     * Name of the array field. This can either be a string or a reference to a
+     * field name from the
+     * [`names`](https://ariakit.org/reference/use-form-store#names) object in the
+     * store, for type safety.
      */
     name: StringLike;
     /**
-     * Value that will be initially set to the item when it is pushed.
+     * Value that will initially be assigned to the array item when it's pushed.
      */
     value: unknown;
     /**

package/esm/form/form-push.js

@@ -4,13 +4,13 @@ import {
 } from "../__chunks/V4ZFXDFK.js";
 import {
   useButton
-} from "../__chunks/VDNZBO4W.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/JH4A3V7P.js";
+import "../__chunks/BVNGIDQK.js";
 import {
   useCollectionItem
 } from "../__chunks/UH3I23HL.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,

package/esm/form/form-radio-group.d.ts

@@ -19,15 +19,20 @@ import type { FormGroupOptions } from "./form-group.js";
  */
 export declare const useFormRadioGroup: import("../utils/types.js").Hook<FormRadioGroupOptions<"div">>;
 /**
- * Renders a radio group in a form.
+ * Renders a group element for
+ * [`FormRadio`](https://ariakit.org/reference/form-radio) elements. The
+ * [`FormGroupLabel`](https://ariakit.org/reference/form-group-label) component
+ * can be used inside this component so the `aria-labelledby` prop is properly
+ * set on the group element.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {8-13}
  * const form = useFormStore({
  *   defaultValues: {
  *     color: "red",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormRadioGroup>
  *     <FormGroupLabel>Favorite color</FormGroupLabel>

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

@@ -1,6 +1,6 @@
 import type { RadioOptions } from "../radio/radio.js";
 import type { As, Props } from "../utils/types.js";
-import type { FormFieldOptions } from "./form-field.js";
+import type { FormControlOptions } from "./form-control.js";
 /**
  * Returns props to create a `FormRadio` component.
  * @see https://ariakit.org/components/form
@@ -22,15 +22,19 @@ import type { FormFieldOptions } from "./form-field.js";
  */
 export declare const useFormRadio: import("../utils/types.js").Hook<FormRadioOptions<"input">>;
 /**
- * Renders a radio button in a form.
+ * Renders a radio button as a form control. This component must be wrapped in a
+ * [`FormRadioGroup`](https://ariakit.org/reference/form-radio-group) along with
+ * other radio buttons sharing the same
+ * [`name`](https://ariakit.org/reference/form-radio#name).
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {10-12}
  * const form = useFormStore({
  *   defaultValues: {
  *     char: "a",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormRadioGroup>
  *     <FormGroupLabel>Favorite character</FormGroupLabel>
@@ -42,6 +46,6 @@ export declare const useFormRadio: import("../utils/types.js").Hook<FormRadioOpt
  * ```
  */
 export declare const FormRadio: import("../utils/types.js").Component<FormRadioOptions<"input">>;
-export interface FormRadioOptions<T extends As = "input"> extends FormFieldOptions<T>, Omit<RadioOptions<T>, "store" | "name"> {
+export interface FormRadioOptions<T extends As = "input"> extends FormControlOptions<T>, Omit<RadioOptions<T>, "store" | "name"> {
 }
 export type FormRadioProps<T extends As = "input"> = Props<FormRadioOptions<T>>;

package/esm/form/form-radio.js

@@ -1,21 +1,21 @@
 "use client";
 import {
-  useFormField
-} from "../__chunks/FS2EVEJO.js";
+  useFormControl
+} from "../__chunks/4GO43MST.js";
 import {
   useFormContext
 } from "../__chunks/V4ZFXDFK.js";
 import {
   useRadio
-} from "../__chunks/JL6IRDFK.js";
+} from "../__chunks/ZICNKKFD.js";
 import "../__chunks/XEV62JUQ.js";
-import "../__chunks/QZLXIDNP.js";
-import "../__chunks/NWCBQ4CV.js";
+import "../__chunks/W7TET3D7.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/UH3I23HL.js";
 import "../__chunks/3IEDWLST.js";
 import "../__chunks/IB7YUKH5.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createElement,
@@ -61,7 +61,7 @@ var useFormRadio = createHook(
       onChange
     });
     props = useRadio(__spreadValues({ value }, props));
-    props = useFormField(__spreadValues({
+    props = useFormControl(__spreadValues({
       store,
       name,
       "aria-labelledby": void 0

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

@@ -31,14 +31,26 @@ export declare const useFormRemove: import("../utils/types.js").Hook<FormRemoveO
 /**
  * Renders a button that will remove an item from an array field in the form
  * when clicked.
+ *
+ * The [`name`](https://ariakit.org/reference/form-remove#name) prop must be
+ * provided to identify the array field. Similarly, the
+ * [`index`](https://ariakit.org/reference/form-remove#index) prop is required
+ * to pinpoint the item to remove.
+ *
+ * By default, the button will automatically move focus to the next field in the
+ * form when clicked, or to the previous field if there isn't a next field. This
+ * behavior can be disabled by setting the
+ * [`autoFocusOnClick`](https://ariakit.org/reference/form-remove#autofocusonclick)
+ * prop to `false`.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {13}
  * const form = useFormStore({
  *   defaultValues: {
  *     languages: ["JavaScript", "PHP"],
  *   },
  * });
+ *
  * const values = form.useState("values");
  *
  * <Form store={form}>
@@ -62,7 +74,10 @@ export interface FormRemoveOptions<T extends As = "button"> extends ButtonOption
      */
     store?: FormStore;
     /**
-     * Name of the array field.
+     * Name of the array field. This can either be a string or a reference to a
+     * field name from the
+     * [`names`](https://ariakit.org/reference/use-form-store#names) object in the
+     * store, for type safety.
      */
     name: StringLike;
     /**

package/esm/form/form-remove.js

@@ -4,10 +4,10 @@ import {
 } from "../__chunks/V4ZFXDFK.js";
 import {
   useButton
-} from "../__chunks/VDNZBO4W.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/JH4A3V7P.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,

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

@@ -15,10 +15,13 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormReset: import("../utils/types.js").Hook<FormResetOptions<"button">>;
 /**
- * Renders a reset buttom in a form.
+ * Renders a button that resets the form to its initial values, as defined by
+ * the
+ * [`defaultValues`](https://ariakit.org/reference/use-form-store#defaultvalues)
+ * prop given to the form store.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {4}
  * const form = useFormStore();
  *
  * <Form store={form}>

package/esm/form/form-reset.js

@@ -4,10 +4,10 @@ import {
 } from "../__chunks/V4ZFXDFK.js";
 import {
   useButton
-} from "../__chunks/VDNZBO4W.js";
-import "../__chunks/NWCBQ4CV.js";
+} from "../__chunks/JH4A3V7P.js";
+import "../__chunks/BVNGIDQK.js";
 import "../__chunks/4UUKJZ4V.js";
-import "../__chunks/KK7H3W2B.js";
+import "../__chunks/54DTKZT5.js";
 import "../__chunks/SHA3WOPI.js";
 import {
   createComponent,

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

@@ -9,7 +9,8 @@ export declare function useFormStoreProps<T extends Omit<FormStore, "useValue" |
     useSubmit: (callback: Core.FormStoreCallback<FormStoreState<FormStoreValues>>) => void;
 };
 /**
- * Creates a form store.
+ * Creates a form store to control the state of
+ * [Form](https://ariakit.org/components/form) components.
  * @example
  * ```jsx
  * const form = useFormStore({
@@ -17,6 +18,7 @@ export declare function useFormStoreProps<T extends Omit<FormStore, "useValue" |
  *     email: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormLabel name={form.names.email}>Email</FormLabel>
  *   <FormInput name={form.names.email} />
@@ -36,18 +38,26 @@ export interface FormStoreState<T extends FormStoreValues = FormStoreValues> ext
 export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues> extends Core.FormStoreFunctions<T>, CollectionStoreFunctions<FormStoreItem> {
     /**
      * A custom hook that rerenders the component when the value of the given
-     * field changes. It returns the value of the field.
-     * @param name The name of the field.
+     * field changes. It accepts a string or a reference to a field name from the
+     * [`names`](https://ariakit.org/reference/use-form-store#names) object in the
+     * store, for type safety. It returns the value of the field.
+     *
+     * Live examples:
+     * - [Form with Select](https://ariakit.org/examples/form-select)
      * @example
      * const nameValue = store.useValue("name");
-     * // Can also use store.names for type-safety.
+     * // Can also use store.names for type safety.
      * const emailValue = store.useValue(store.names.email);
      */
     useValue: <T = any>(name: StringLike) => T;
     /**
      * Custom hook that accepts a callback that will be used to validate the form
-     * when `form.validate` is called.
-     * @param callback The callback that receives the form state as argument.
+     * when [`validate`](https://ariakit.org/reference/use-form-store#validate) is
+     * called, typically when a form field is touched or when the form is
+     * submitted.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
      * @example
      * store.useValidate(async (state) => {
      *   const errors = await api.validate(state.values);
@@ -59,8 +69,12 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
     useValidate: (callback: Core.FormStoreCallback<FormStoreState<T>>) => void;
     /**
      * Custom hook that accepts a callback that will be used to submit the form
-     * when `form.submit` is called.
-     * @param callback The callback that receives the form state as argument.
+     * when [`submit`](https://ariakit.org/reference/use-form-store#submit) is
+     * called.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [Form with Select](https://ariakit.org/examples/form-select)
      * @example
      * store.useSubmit(async (state) => {
      *   try {
@@ -74,8 +88,9 @@ export interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues>
 }
 export interface FormStoreOptions<T extends FormStoreValues = FormStoreValues> extends Core.FormStoreOptions<T>, CollectionStoreOptions<FormStoreItem> {
     /**
-     * Function that will be called when `values` state changes.
-     * @param values The new values.
+     * Function that will be called when
+     * [`values`](https://ariakit.org/reference/use-form-store#values) state
+     * changes.
      * @example
      * function MyForm({ values, onChange }) {
      *   const form = useFormStore({ values, setValues: onChange });
@@ -83,15 +98,17 @@ export interface FormStoreOptions<T extends FormStoreValues = FormStoreValues> e
      */
     setValues?: (values: FormStoreState<T>["values"]) => void;
     /**
-     * Function that will be called when the `errors` state changes.
-     * @param errors The new errors.
+     * Function that will be called when the
+     * [`errors`](https://ariakit.org/reference/use-form-store#errors) state
+     * changes.
      * @example
      * useFormStore({ setErrors: (errors) => console.log(errors) });
      */
     setErrors?: (errors: FormStoreState<T>["errors"]) => void;
     /**
-     * Function that will be called when the `touched` state changes.
-     * @param touched The new touched state.
+     * Function that will be called when the
+     * [`touched`](https://ariakit.org/reference/use-form-store#touched) state
+     * changes.
      * @example
      * useFormStore({ setTouched: (touched) => console.log(touched) });
      */