Skip to main content

Radio Group

Rocket 2.0

The Radio Group component lets the user pick exactly one option from a short visible list, such as a plan, a shipping method or a priority.

Properties​

Property
Description
Expected Value
LabelText shown above the options.Text. Default: Label
Help textHint text shown under the options.Text
OptionsOptions to choose from, as plain values or as items with a label and a value that can add disabled.Array. Default: ["Standard", "Premium", "Charter"]
Default valueValue of the option selected when the app loads.Text. Default: Standard
Allow deselectLets the user clear the choice by clicking the selected option again. Has no effect when the field is mandatory.On or off. Default: Off
Side by sideLays the options out in a row instead of a column.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 selection changeTriggers when the selected 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
Select optionSelects the option with the given Value. A value that matches no option is ignored.components.radiogroup1.selectOption("")
Deselect optionClears the selection.components.radiogroup1.deselectOption()
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.{{components.radiogroup1.label}}
descriptionHint text shown under the options.{{components.radiogroup1.description}}
optionsOptions to choose from, as plain values or as items with a label and a value that can add disabled.{{components.radiogroup1.options}}
defaultValueValue of the option selected when the app loads.{{components.radiogroup1.defaultValue}}
allowDeselectLets the user clear the choice by clicking the selected option again. Has no effect when the field is mandatory.{{components.radiogroup1.allowDeselect}}
horizontalLays the options out in a row instead of a column.{{components.radiogroup1.horizontal}}
valueThe value of the selected option, or empty when none is selected.{{components.radiogroup1.value}}
selectedOptionThe selected option, with its label and value.{{components.radiogroup1.selectedOption}}
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
Selected colorTheme: Brand primary
Label colorTheme: Primary text
Help text colorTheme: Placeholder text
Option text colorTheme: Primary text
Error colorTheme: Error
Option text color (earlier name)—
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.