Docs

Option	Description
`component`	The name of the plugin component. Always 'radio-group'.
`name`	The path to some value in the data being edited.
`options`	An array of strings or Options to select from.
`direction`	An optional string indicating whether to render the radios in a "horizontal" or "vertical" orientation. This will default to "horizontal" if no value is passed. (Optional)
`variant`	An optional string indicating whether the "radio" or "button" variant should be used. This will default to "radio" if no value is passed. (Optional)
`label`	A human readable label for the field. Defaults to the name. (Optional)
`description`	Description that expands on the purpose of the field or prompts a specific action. (Optional)

interface RadioGroupField {
  name: string
  component: string
  label?: string
  options: (Option | string)[]
  direction?: 'horizontal' | 'vertical'
}

type Option = {
  value: string
  label: string
}

These interfaces only show the keys unique to the radio group field. Visit the Field Config docs for a complete list of options.

Example: Select an Rating

Below is an example of how a radio group field could be used to choose a rating of a customer review.

const ReviewForm = {
  fields: [
    {
      type: 'string',
      name: 'rating',
      label: 'Rating',
      description: 'Choose a rating for this review',
      options: [
        { label: '★', value: 'one_star' },
        { label: '★★', value: 'two_star' },
        { label: '★★★', value: 'three_star' },
        { label: '★★★★', value: 'four_star' },
        { label: '★★★★★', value: 'five_star' },
      ],
      ui: {
        component: 'radio-group',
        direction: 'vertical',
      },
    },
    // ...
  ],
}