Skip to main content

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
LabelText shown above the options, or beside them when Layout is horizontal.Text. Default: Shipping
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
OptionsThe choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Express', value: 'express' }].Array
ValueValue of the option picked at the start. A value that matches no option is cleared once the options load.Text
Option typedefault shows round radio buttons; button shows the options as a row of joined buttons.default, button. Default: default
Button styleLook 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
VerticalStacks the radio buttons in a column instead of a row.On or off. Default: Off
SizeSize of the options when Option type is button.small, middle, large. Default: middle
Allow deselectLets 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
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets 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 desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows 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 changeTriggers 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 valuePicks the option with the given Value.components.radiogroup1.setFieldValue("")
Reset fieldSets the choice back to the Value property.components.radiogroup1.resetFields()
Set visibilityShows the component when true, hides it when false.components.radiogroup1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.radiogroup1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.radiogroup1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the options, or beside them when Layout is horizontal.{{components.radiogroup1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.radiogroup1.extra}}
tooltipText shown from an info icon after the label.{{components.radiogroup1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.radiogroup1.layout}}
optionsThe choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Express', value: 'express' }].{{components.radiogroup1.options}}
valueValue of the option picked at the start. A value that matches no option is cleared once the options load.{{components.radiogroup1.value}}
optionTypedefault shows round radio buttons; button shows the options as a row of joined buttons.{{components.radiogroup1.optionType}}
buttonStyleLook 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}}
verticalStacks the radio buttons in a column instead of a row.{{components.radiogroup1.vertical}}
sizeSize of the options when Option type is button.{{components.radiogroup1.size}}
allowDeselectLets the user clear the choice by clicking the picked option again.{{components.radiogroup1.allowDeselect}}
isVisibleWhether the component is visible.{{components.radiogroup1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.radiogroup1.isLoading}}
isDisabledWhether the component is disabled.{{components.radiogroup1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 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.