Skip to main content

The Radio Group component for Retool Apps

A group of radio buttons to select a single value.

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

captionByIndex

A list of captions for each item, by index.

Type array
Format Plain Text
Array values string
Configurability Read-only
Default[]
Examples
["Caption 1", "Caption 2"]

deprecatedLabels

A list of labels (deprecated).

Type array
Array values string
Configurability Read-only
Defaultnull

disabled

Whether input, interaction, selection, or triggering is disabled.

Type boolean
Format True/False
Configurability Inspector > Interaction > Disabled
Defaultfalse
Examples
true

disabledByIndex

A list of values for each item, by index, that reflect whether they are disabled.

Type array
Array values boolean
Configurability Read-only
Default[]
Examples
[true, false, true]

disabledValues

A list of values not available for selection.

Type array
Array values boolean
Configurability Read-only
Defaultnull

events

A list of configured event handlers that trigger actions or queries.

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type string
Configurability Inspector > Interaction > Event handlers > Event
Defaultnull

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Defaultnull

type

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

Defaultnull


groupLayout

The layout of grouped items.

Type string
Configurability Inspector > Appearance > Group layout
Allowed Values
ValueUI OptionDescription
multiColumnTree

Display items in multiple columns based on the number of items and size.

singleColumnSingle column

Always display items in a single column.

wrapWrap

Wrap items.

autoAuto

Automatically display items in multiple columns based on the number of items and size.

Defaultauto

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type string
Format Plain Text
Configurability Inspector > Spacing > Height
Allowed Values
ValueDescription
auto

Expand to fit content.

fixed

Fixed height.

fill
Defaultfixed

hiddenByIndex

A list of items, by index, and whether they are hidden.

Type array
Array values boolean
Configurability Read-only
Default[]
Examples
[true, false, true]

id

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
DefaultradioGroup1
Examples
query1
button1

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on desktop
Defaultfalse
Examples
true

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on mobile
Defaulttrue
Examples
true

labelPosition

The position of the label relative to the input field or value.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Label > Position
Allowed Values
ValueUI OptionDescription
topTop

Above the input field or value.

leftLeft

Left of the input field or value.

Defaultleft
Examples
top

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type array
Array values string
Configurability Read-only
Default[]
Examples
["Label 1", "Label 2", "Label 3"]

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Maintain space when hidden
Defaultfalse
Examples
true

margin

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
4px 8px

minColumnWidth

The minimum width of a column when using a multi-column layout.

Type number
Formatnumber
Configurability Inspector > Appearance > Min col width
Defaultnull
Examples
100

Examples
true

selectedIndex

The selected values, by index.

Type number
Format Integer
Configurability Read-only
Default[]
Examples
["Value 1", "Value 2"]

selectedItem

The selected item.

Type string | number | boolean | object | array
Format Custom data
Configurability Read-only
Defaultnull
Examples
{"id": "1", "name": "Item 1"}

selectedLabel

The label of the selected value, by index.

Type string
Formatstring
Configurability Read-only
Defaultnull
Examples
Value 1

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Always show in edit mode
Defaultfalse
Examples
true

style

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

tooltipByIndex

A list of tooltips for each item, by index.

Type array
Array values string
Configurability Read-only
Default[]
Examples
["Tooltip 1", "Tooltip 2"]

tooltipText

The tooltip text to display next to the label on hover.

Type string
Format Markdown
Configurability Inspector > Content > Add-ons > Helper text
Defaultnull
Examples
Submit

value

The value.

Type array
Array values string
Configurability Read-only
Defaultnull

values

A list of possible values from which to select.

Type array
Configurability Read-only
Defaultnull

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

radioGroup.clearValidation()

Clear the validation message from the input field.

Definition
radioGroup.clearValidation()
Examples

Clear the validation message from radioGroup.

radioGroup.clearValidation();

radioGroup.clearValue()

Clear the current values.

Definition
radioGroup.clearValue()
Examples

Clear the current value of radioGroup.

radioGroup.clearValue();

radioGroup.focus()

Set focus on the input field.

Definition
radioGroup.focus()
Examples

Set focus on radioGroup.

radioGroup.focus();

radioGroup.resetValue()

Reset the current value to the default value.

Definition
radioGroup.resetValue()
Examples

Reset the current value of radioGroup.

radioGroup.resetValue();

radioGroup.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition
radioGroup.scrollIntoView(options)
Parameters

options

The scroll options.

Type object
Object Properties

behavior

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
nearest

Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.

start

Scrolls to position the component at the top of the visible area.

center

Scrolls to position the component in the middle of the visible area.

end

Scrolls to position the component at the bottom of the visible area.



Examples

Scroll the minimum amount to immediately bring radioGroup into view.

radioGroup.scrollIntoView({behavior: 'auto', block: 'nearest'});

radioGroup.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition
radioGroup.setDisabled(disabled)
Parameters

disabled

Whether input, interaction, selection, or triggering is disabled.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Disable radioGroup.

radioGroup.setDisabled(true);

Enable radioGroup.

radioGroup.setDisabled(false);

radioGroup.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition
radioGroup.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide radioGroup.

radioGroup.setHidden(true);

Unhide radioGroup.

radioGroup.setHidden(false);

radioGroup.setValue()

Set the current value.

Definition
radioGroup.setValue(key, value)
Parameters

key

The key.

Type string

value

The value.

Type string | number | boolean | object | array

Examples

Set the current value of radioGroup to userValue.

radioGroup.setValue(userValue);

radioGroup.validate()

Validates the value of the input field.

Definition
radioGroup.validate()
Examples

Validate the value of radioGroup.

radioGroup.validate();

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

EventDescription
ChangeThe value is changed.