Skip to content

Radio properties

PropertiesDescription
value(required) defines the value as a string. Use it to get the value during the on_change event listener callback in the RadioGroup.
checked(optional) determine whether the radio is checked or not. Default will be false.
group(optional) use a unique group identifier to define the Radio buttons that belongs together.
size(optional) the size of the Radio button. For now there is medium (default) and large.
label(optional) use either the label property or provide a custom one.
label_position(optional) defines the position of the label. Use either left or right. Defaults to right.
label_sr_only(optional) use true to make the label only readable by screen readers.
status(optional) text with a status message. The style defaults to an error message. You can use true to only get the status color, without a message.
status_state(optional) defines the state of the status. Currently, there are two statuses [error, info]. Defaults to error.
status_props(optional) use an object to define additional FormStatus properties.
globalStatus(optional) the configuration used for the target GlobalStatus.

Radio.Group properties

PropertiesDescription
value(optional) defines the pre-selected Radio button. The value has to match the one provided in the Radio button. Use a string value.
name(optional) custom grouping name. Defaults to a random name.
layout_direction(optional) Define the layout direction of the Radio buttons. Can be either column or row. Defaults to column.
size(optional) the size of the Radio button. For now there is medium (default) and large.
status(optional) uses the form-status component to show failure messages.
status_state(optional) defines the state of the status. Currently, there are two statuses [error, info]. Defaults to error.
status_props(optional) use an object to define additional FormStatus properties.
globalStatus(optional) the configuration used for the target GlobalStatus.
label(optional) use either the label property or provide a custom one.
label_direction(optional) to define the label layout direction on how the next element should be placed on. Can be either vertical or horizontal. Defaults to horizontal.
label_sr_only(optional) use true to make the label only readable by screen readers.
vertical(optional) will force both direction and label_direction to be vertical if set to true.

Radio group Context

You can also pass through label_position and some more Radio button properties to the Group. This way all nested Radio buttons will get the properties.