@ariakit/react-core 0.3.12 → 0.3.14

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

@@ -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/cjs/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/cjs/form/form-control.cjs

@@ -0,0 +1,16 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
+
+
+
+var _N3XK7EAHcjs = require('../__chunks/N3XK7EAH.cjs');
+require('../__chunks/FROYTN4B.cjs');
+require('../__chunks/R5A2WTWB.cjs');
+require('../__chunks/BZTDJIVT.cjs');
+require('../__chunks/RNZNGEL4.cjs');
+require('../__chunks/EO6LS72H.cjs');
+require('../__chunks/CJDHQUBR.cjs');
+require('../__chunks/AV6KTKLE.cjs');
+
+
+
+exports.FormControl = _N3XK7EAHcjs.FormControl; exports.useFormControl = _N3XK7EAHcjs.useFormControl;

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

@@ -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/cjs/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/cjs/form/form-description.d.cts

@@ -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/cjs/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/cjs/form/form-error.d.cts

@@ -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/cjs/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/cjs/form/form-field.cjs

@@ -1,16 +1,31 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});"use client";
 
 
-
-var _VCDQISP7cjs = require('../__chunks/VCDQISP7.cjs');
+var _N3XK7EAHcjs = require('../__chunks/N3XK7EAH.cjs');
 require('../__chunks/FROYTN4B.cjs');
 require('../__chunks/R5A2WTWB.cjs');
 require('../__chunks/BZTDJIVT.cjs');
-require('../__chunks/RNZNGEL4.cjs');
+
+
+
+
+var _RNZNGEL4cjs = require('../__chunks/RNZNGEL4.cjs');
 require('../__chunks/EO6LS72H.cjs');
 require('../__chunks/CJDHQUBR.cjs');
 require('../__chunks/AV6KTKLE.cjs');
 
+// src/form/form-field.ts
+var useFormField = _RNZNGEL4cjs.createHook.call(void 0, (props) => {
+  return _N3XK7EAHcjs.useFormControl.call(void 0, props);
+});
+var FormField = _RNZNGEL4cjs.createMemoComponent.call(void 0, (props) => {
+  const htmlProps = useFormField(props);
+  return _RNZNGEL4cjs.createElement.call(void 0, "input", htmlProps);
+});
+if (process.env.NODE_ENV !== "production") {
+  FormField.displayName = "FormField";
+}
+
 
 
-exports.FormField = _VCDQISP7cjs.FormField; exports.useFormField = _VCDQISP7cjs.useFormField;
+exports.FormField = FormField; exports.useFormField = useFormField;

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

@@ -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/cjs/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/cjs/form/form-group-label.d.cts

@@ -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/cjs/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>