@ariakit/react-core 0.3.12 → 0.3.14

package/esm/focus-trap/focus-trap-region.d.ts

@@ -10,8 +10,10 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusTrapRegion: import("../utils/types.js").Hook<FocusTrapRegionOptions<"div">>;
 /**
- * Renders a focus trap region element.
- * @see https://ariakit.org/components/focus-trap-region
+ * Renders a wrapper element that traps the focus inside it when the
+ * [`enabled`](https://ariakit.org/reference/focus-trap-region#enabled) prop is
+ * `true`.
+ * @see https://ariakit.org/components/focus-trap
  * @example
  * ```jsx
  * <FocusTrapRegion>

package/esm/focusable/focusable-container.d.ts

@@ -10,8 +10,9 @@ import type { As, Options, Props } from "../utils/types.js";
  */
 export declare const useFocusableContainer: import("../utils/types.js").Hook<FocusableContainerOptions<"div">>;
 /**
- * Renders a div that wraps `Focusable` components and controls whether they
- * can be auto focused.
+ * Renders a div that wraps
+ * [`Focusable`](https://ariakit.org/reference/focusable) components and
+ * controls whether they can be auto-focused.
  * @see https://ariakit.org/components/focusable
  * @example
  * ```jsx
@@ -23,9 +24,10 @@ export declare const useFocusableContainer: import("../utils/types.js").Hook<Foc
 export declare const FocusableContainer: import("../utils/types.js").Component<FocusableContainerOptions<"div">>;
 export type FocusableContainerOptions<T extends As = "div"> = Options<T> & {
     /**
-     * Determines whether focusable elements inside the container should be
-     * automatically focused when the container is shown and they have the
-     * `autoFocus` prop.
+     * Determines whether [`Focusable`](https://ariakit.org/reference/focusable)
+     * elements inside the container should be automatically focused when the
+     * container is shown and they have the
+     * [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.
      * @default true
      */
     autoFocusOnShow?: boolean;

package/esm/focusable/focusable.d.ts

@@ -46,6 +46,7 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
      * Live examples:
      * - [Submenu](https://ariakit.org/examples/menu-nested)
      * - [Combobox with tabs](https://ariakit.org/examples/combobox-tabs)
+     * - [Context Menu](https://ariakit.org/examples/menu-context-menu)
      * @default false
      */
     disabled?: boolean;
@@ -109,8 +110,10 @@ export interface FocusableOptions<T extends As = "div"> extends Options<T> {
     accessibleWhenDisabled?: boolean;
     /**
      * Custom event handler invoked when the element gains focus through keyboard
-     * interaction or a key press occurs while the element is in focus. This is a
-     * programmatic equivalent of the `data-focus-visible` attribute.
+     * interaction or a key press occurs while the element is in focus. This is
+     * the programmatic equivalent of the
+     * [`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)
+     * attribute.
      *
      * Live examples:
      * - [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)

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

@@ -1,6 +1,6 @@
 import type { CheckboxOptions } from "../checkbox/checkbox.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 `FormCheckbox` component.
  * @see https://ariakit.org/components/form
@@ -18,15 +18,17 @@ import type { FormFieldOptions } from "./form-field.js";
  */
 export declare const useFormCheckbox: import("../utils/types.js").Hook<FormCheckboxOptions<"input">>;
 /**
- * Renders a checkbox as a form field.
+ * Renders a checkbox input as a form control, representing a boolean, string,
+ * number, or array value.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {9}
  * const form = useFormStore({
  *   defaultValues: {
  *     acceptTerms: false,
  *   },
  * });
+ *
  * <Form store={form}>
  *   <label>
  *     <FormCheckbox name={form.names.acceptTerms} />
@@ -36,6 +38,6 @@ export declare const useFormCheckbox: import("../utils/types.js").Hook<FormCheck
  * ```
  */
 export declare const FormCheckbox: import("../utils/types.js").Component<FormCheckboxOptions<"input">>;
-export interface FormCheckboxOptions<T extends As = "input"> extends FormFieldOptions<T>, Omit<CheckboxOptions<T>, "store" | "name"> {
+export interface FormCheckboxOptions<T extends As = "input"> extends FormControlOptions<T>, Omit<CheckboxOptions<T>, "store" | "name"> {
 }
 export type FormCheckboxProps<T extends As = "input"> = Props<FormCheckboxOptions<T>>;

package/esm/form/form-checkbox.js

@@ -1,17 +1,17 @@
 "use client";
 import {
-  useFormField
-} from "../__chunks/FS2EVEJO.js";
+  useFormControl
+} from "../__chunks/4GO43MST.js";
 import {
   useFormContext
 } from "../__chunks/V4ZFXDFK.js";
+import {
+  useCheckboxStore
+} from "../__chunks/JIZ5C2JK.js";
 import {
   useCheckbox
 } from "../__chunks/3AHQ6JCP.js";
 import "../__chunks/VPR2WHQV.js";
-import {
-  useCheckboxStore
-} from "../__chunks/JIZ5C2JK.js";
 import "../__chunks/6XBVQI3K.js";
 import "../__chunks/NWCBQ4CV.js";
 import "../__chunks/UH3I23HL.js";
@@ -48,7 +48,7 @@ var useFormCheckbox = createHook(
       setValue: (value2) => store == null ? void 0 : store.setValue(name, value2)
     });
     props = useCheckbox(__spreadValues({ store: checkboxStore, value, checked }, props));
-    props = useFormField(__spreadValues({
+    props = useFormControl(__spreadValues({
       store,
       name,
       "aria-labelledby": void 0

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

@@ -0,0 +1,93 @@
+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";
+/**
+ * Returns props to create a `FormControl` 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
+ * @example
+ * ```jsx
+ * const store = useFormStore({ defaultValues: { content: "" } });
+ * const props = useFormControl({ store, name: store.names.content });
+ * const value = store.useValue(store.names.content);
+ *
+ * <Form store={store}>
+ *   <FormLabel name={store.names.content}>Content</FormLabel>
+ *   <Role
+ *     {...props}
+ *     value={value}
+ *     onChange={(value) => store.setValue(store.names.content, value)}
+ *     render={<Editor />}
+ *   />
+ * </Form>
+ * ```
+ */
+export declare const useFormControl: import("../utils/types.js").Hook<FormControlOptions<"input">>;
+/**
+ * Abstract component that renders a form control. 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
+ * @example
+ * ```jsx {11-19}
+ * const form = useFormStore({
+ *   defaultValues: {
+ *     content: "",
+ *   },
+ * });
+ *
+ * const value = form.useValue(form.names.content);
+ *
+ * <Form store={form}>
+ *   <FormLabel name={form.names.content}>Content</FormLabel>
+ *   <FormControl
+ *     name={form.names.content}
+ *     render={
+ *       <Editor
+ *         value={value}
+ *         onChange={(value) => form.setValue(form.names.content, value)}
+ *       />
+ *     }
+ *   />
+ * </Form>
+ * ```
+ */
+export declare const FormControl: import("../utils/types.js").Component<FormControlOptions<"input">>;
+export interface FormControlOptions<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;
+    /**
+     * Field name. This can either be a string corresponding to an existing
+     * property name in the
+     * [`values`](https://ariakit.org/reference/use-form-store#values) state of
+     * the store, or a reference to a field name from the
+     * [`names`](https://ariakit.org/reference/use-form-store#names) object in the
+     * store, ensuring type safety.
+     *
+     * Live examples:
+     * - [FormRadio](https://ariakit.org/examples/form-radio)
+     * - [Form with Select](https://ariakit.org/examples/form-select)
+     */
+    name: StringLike;
+    /**
+     * Whether the field should be marked touched on blur.
+     * @default true
+     */
+    touchOnBlur?: BooleanOrCallback<FocusEvent>;
+}
+export type FormControlProps<T extends As = "input"> = Props<FormControlOptions<T>>;

package/esm/form/form-control.js

@@ -0,0 +1,16 @@
+"use client";
+import {
+  FormControl,
+  useFormControl
+} from "../__chunks/4GO43MST.js";
+import "../__chunks/V4ZFXDFK.js";
+import "../__chunks/UH3I23HL.js";
+import "../__chunks/4UUKJZ4V.js";
+import "../__chunks/3ORBWXWF.js";
+import "../__chunks/6O5OEQGF.js";
+import "../__chunks/XM66DUTO.js";
+import "../__chunks/4R3V3JGP.js";
+export {
+  FormControl,
+  useFormControl
+};

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

@@ -18,15 +18,17 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormDescription: import("../utils/types.js").Hook<FormDescriptionOptions<"div">>;
 /**
- * Renders a description element for a form field.
+ * Renders a description element for a form field, which will automatically
+ * receive an `aria-describedby` attribute pointing to this element.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {10-12}
  * const form = useFormStore({
  *   defaultValues: {
  *     password: "",
  *   },
  * });
+ *
  * <Form store={form}>
  *   <FormLabel name={form.names.password}>Password</FormLabel>
  *   <FormInput name={form.names.password} type="password" />
@@ -47,7 +49,16 @@ export interface FormDescriptionOptions<T extends As = "div"> extends Collection
      */
     store?: FormStore;
     /**
-     * Name of the field.
+     * Name of the field described 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
+     * <FormDescription name="password">
+     *   Password with at least 8 characters.
+     * </FormDescription>
+     * ```
      */
     name: StringLike;
 }

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

@@ -25,11 +25,11 @@ import type { FormStore } from "./form-store.js";
  */
 export declare const useFormError: import("../utils/types.js").Hook<FormErrorOptions<"div">>;
 /**
- * Renders an element that displays an error message. The `children` will be
- * automatically set to the error message set on the store.
+ * Renders an element that shows an error message. The `children` will
+ * automatically display the error message defined in the store.
  * @see https://ariakit.org/components/form
  * @example
- * ```jsx
+ * ```jsx {16}
  * const form = useFormStore({
  *   defaultValues: {
  *     email: "",
@@ -60,7 +60,14 @@ export interface FormErrorOptions<T extends As = "div"> extends CollectionItemOp
      */
     store?: FormStore;
     /**
-     * Name of the field.
+     * Name of the field associated with this error. 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
+     * <FormError name="password" />
+     * ```
      */
     name: StringLike;
 }

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";
@@ -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;
     /**