The Radio Group field allows selecting a single value from a list of values.
Editing UI Widget
This field is displayed as a set of radio buttons labelled with the field’s label
in the Content Editor.
Output Format
The Radio Group field outputs the selected value in its predefined type.
Options
The following options are available for this field (default values shown):
{
"type": 'inline',
"options": []
}
type: how to display the radio buttons, may be one of the following:
inline: display the radio buttons next to each other, wrapping to a new line if there is not enough space
wide: display each radio button on its own line, filling the entire available width
segmented: use a segmented selector (similar to a tab-strip) for displaying the options
options: the options available in the Radio Group field. May be either an array of values, an array of
{ label, value }
objects, or an object containing apath
to a JSON file and akey
to look an options array up under
Validation
The following validation options are available for this field (default values shown):
{
"required": false
}
Notes
If you only have more than a couple of options to select from, or want users to be able to select multiple values, you may be looking for the Dropdown and Checkboxes fields.
If you configure the field to pull options from a file by providing a path to a JSON file and a key in options.options
, make sure that the value of that key is an array of non-object values like numbers or strings, or an array of { label, value }
objects. JSON-files consisting of a single array are currently unsupported. The value of label
is what will be displayed to the user, while the value of value
is what will be stored when the option is selected.
Version History
Version at launch: 1