Ariakit
/

FormGroupLabel

Renders a label in a form group. This component must be wrapped with the FormGroup or FormRadioGroup components so the aria-labelledby prop is properly set on the form group element.

Code examples

const form = useFormStore({
username: "",
email: "",
},
});
<Form store={form}>
<FormLabel name={form.names.username}>Username</FormLabel>
<FormInput name={form.names.username} />
<FormLabel name={form.names.email}>Email</FormLabel>
<FormInput name={form.names.email} />
</Form>

Optional Props


render

RenderProp<React.HTMLAttributes<any> & React.RefAttributes<any>> | React.ReactElement<any, 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.

Check out the Composition guide for more details.


store

FormStore<FormStoreValues> | undefined

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

Follow updates

Join 1,000+ subscribers and receive monthly updates with the latest improvements on API Reference.

Read latest issue

No Spam. Unsubscribe at any time.