FormDescription

Form

Renders a description element for a form field, which will automatically receive an aria-describedby attribute pointing to this element.

Code examples

const form = useFormStore({
  defaultValues: {
    password: "",
  },
});

<Form store={form}>
  <FormLabel name={form.names.password}>Password</FormLabel>
  <FormInput name={form.names.password} type="password" />
  <FormDescription name={form.names.password}>
    Password with at least 8 characters.
  </FormDescription>
</Form>
const form = useFormStore({
  defaultValues: {
    password: "",
  },
});

<Form store={form}>
  <FormLabel name={form.names.password}>Password</FormLabel>
  <FormInput name={form.names.password} type="password" />
  <FormDescription name={form.names.password}>
    Password with at least 8 characters.
  </FormDescription>
</Form>

Required Props

`name`

StringLike
StringLike

Name of the field described by this element. This can either be a string or a reference to a field name from the names object in the store, for type safety.

Code examples

<FormDescription name="password">
  Password with at least 8 characters.
</FormDescription>
<FormDescription name="password">
  Password with at least 8 characters.
</FormDescription>

Optional Props

`getItem`

((props: CollectionStoreItem) => CollectionStoreItem) | undefined
((props: CollectionStoreItem) => CollectionStoreItem) | undefined

A memoized function that returns props to be passed with the item during its registration in the store.

Code examples

const getItem = useCallback((data) => ({ ...data, custom: true }), []);
<CollectionItem getItem={getItem} />
const getItem = useCallback((data) => ({ ...data, custom: true }), []);
<CollectionItem getItem={getItem} />

`id`

string | undefined
string | undefined

The unique ID of the item. This will be used to register the item in the store and for the element's id attribute. If not provided, a unique ID will be automatically generated.

Live examples

Combobox with TabsOrganizing Combobox with Tab components that support mouse, keyboard, and screen reader interactions. The UI remains responsive by using React.startTransition.

Tab with React RouterUsing React Router to create Tab links and tab panels controlled by the browser history, while maintaining keyboard navigation.

Animated TabPanelUsing plain CSS transitions to slide in and out TabPanel components as they are expanded.

Select with Combobox and TabsAbstracting Select to work alongside Combobox and Tab components, presenting a searchable, tabbed dropdown.

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged.

Some Ariakit components detect the type of the underlying element when they mount. If the render element's type may change while the component is mounted, pass a key⁠ prop that changes with the element type so React remounts the component with the new element. Remounting resets uncontrolled state, so keep the relevant state controlled:

<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>
<Checkbox
  key={custom ? "custom" : "native"}
  checked={checked}
  onChange={() => setChecked(!checked)}
  render={custom ? <div /> : <input />}
/>

Check out the Composition guide for more details.

`shouldRegisterItem`

boolean | undefined = true
boolean | undefined = true

Whether the item should be registered as part of the collection.

`store`

FormStore<FormStoreValues> | undefined
FormStore<FormStoreValues> | undefined

Object returned by the useFormStore hook. If not provided, the closest Form or FormProvider components' context will be used.

FormDescription

Code examples

Code examples

Live examples

Stay tuned