FormRadioGroup

Form

Renders a group element for FormRadio elements. The FormGroupLabel component can be used inside this component so the aria-labelledby prop is properly set on the group element.

Code examples

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

<Form store={form}>
  <FormRadioGroup>
    <FormGroupLabel>Favorite color</FormGroupLabel>
    <FormRadio name={form.names.color} value="red" />
    <FormRadio name={form.names.color} value="blue" />
    <FormRadio name={form.names.color} value="green" />
  </FormRadioGroup>
</Form>
const form = useFormStore({
  defaultValues: {
    color: "red",
  },
});

<Form store={form}>
  <FormRadioGroup>
    <FormGroupLabel>Favorite color</FormGroupLabel>
    <FormRadio name={form.names.color} value="red" />
    <FormRadio name={form.names.color} value="blue" />
    <FormRadio name={form.names.color} value="green" />
  </FormRadioGroup>
</Form>

Optional Props

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | 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
FormStore<FormStoreValues> | undefined

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

FormRadioGroup

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`