Radio Group Field

This is an advanced-use feature, and likely not something you'll need to configure. What you probably want is the content types reference!

The radio-group field represents a group of radio inputs. It can rendered in a "horizontal" or "vertical" direction.

Options

REQUIRED
component
string

The name of the plugin component. Always 'radio-group'.


REQUIRED
name
string

The path to some value in the data being edited.


REQUIRED
options
(Option | string)[]

An array of strings or Options to select from.


direction
'horizontal' | 'vertical'

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.

Default is 'horizontal'.

variant
'radio' | 'button'

An optional string indicating whether the "radio" or "button" variant should be used. This will default to "radio" if no value is passed.

Default is 'radio'.

label
string

A human readable label for the field. Defaults to the name.


description
string

Description that expands on the purpose of the field or prompts a specific action.

All properties marked as REQUIRED must be specified for the field to work properly.

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.