Radio Group
Ant Design
The Radio Group component is Ant Design's set of radio buttons. Users pick exactly one of a few options that are all visible at once, such as a shipping method or a priority.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the options, or beside them when Layout is horizontal. | Text. Default: Shipping |
| Extra | Help text shown under the field. A validation message replaces it while the value is not valid. | Text |
| Tooltip | Text shown from an info icon after the label. | Text |
| Layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | vertical, horizontal. Default: vertical |
| Options | The choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Express', value: 'express' }]. | Array |
| Value | Value of the option picked at the start. A value that matches no option is cleared once the options load. | Text |
| Option type | default shows round radio buttons; button shows the options as a row of joined buttons. | default, button. Default: default |
| Button style | Look of the picked button when Option type is button. solid fills it with the primary color; outline only colors its border and text. | outline, solid. Default: solid |
| Vertical | Stacks the radio buttons in a column instead of a row. | On or off. Default: Off |
| Size | Size of the options when Option type is button. | small, middle, large. Default: middle |
| Allow deselect | Lets the user clear the choice by clicking the picked option again. | On or off. Default: Off |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets the component grow with its content in the running app instead of keeping a fixed height. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows the component in the mobile layout. | On or off. Default: Off |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On change | Triggers when the picked option changes. |
Component Specific Actions (CSA)​
Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.
Action | Description | How To Access |
|---|---|---|
| Set field value | Picks the option with the given Value. | components.radiogroup1.setFieldValue("") |
| Reset field | Sets the choice back to the Value property. | components.radiogroup1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.radiogroup1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.radiogroup1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.radiogroup1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the options, or beside them when Layout is horizontal. | {{components.radiogroup1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.radiogroup1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.radiogroup1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.radiogroup1.layout}} |
options | The choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Express', value: 'express' }]. | {{components.radiogroup1.options}} |
value | Value of the option picked at the start. A value that matches no option is cleared once the options load. | {{components.radiogroup1.value}} |
optionType | default shows round radio buttons; button shows the options as a row of joined buttons. | {{components.radiogroup1.optionType}} |
buttonStyle | Look of the picked button when Option type is button. solid fills it with the primary color; outline only colors its border and text. | {{components.radiogroup1.buttonStyle}} |
vertical | Stacks the radio buttons in a column instead of a row. | {{components.radiogroup1.vertical}} |
size | Size of the options when Option type is button. | {{components.radiogroup1.size}} |
allowDeselect | Lets the user clear the choice by clicking the picked option again. | {{components.radiogroup1.allowDeselect}} |
isVisible | Whether the component is visible. | {{components.radiogroup1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.radiogroup1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.radiogroup1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 0px 0px 0px #00000040 |
A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.