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 |
| Mutability | Read-only |
| Default | |
Examples
["Caption 1", "Caption 2"]
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
disabledByIndex
A list of values for each item, by index, that reflect whether they are disabled.
| Type | array |
| Array values | boolean |
| Mutability | Read-only |
| Default | |
Examples
[true, false, true]
disabledValues
A list of values not available for selection.
| Type | array |
| Array values | boolean |
| Mutability | Read-only |
groupLayout
The layout of grouped items.
| Type | string | |||||||||||||||
| Mutability |
| |||||||||||||||
| Allowed Values |
| |||||||||||||||
| Default | |
heightType
Whether the height automatically adjusts to fit content or is a fixed size.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Mutability |
| ||||||||
| Allowed Values |
| ||||||||
| Default | |
hiddenByIndex
A list of items, by index, and whether they are hidden.
| Type | array |
| Array values | boolean |
| Mutability | Read-only |
| Default | |
Examples
[true, false, true]
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
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 |
| Mutability | Read-only |
| Default | |
Examples
["Label 1", "Label 2", "Label 3"]
minColumnWidth
The minimum width of a column when using a multi-column layout.
| Type | number | ||||
| Format | number | ||||
| Mutability |
| ||||
| Default | |
Examples
100
required
Whether a value is required to be selected.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
Examples
["Value 1", "Value 2"]
selectedItem
The selected item.
| Type | string | number | boolean | object | array |
| Format | Custom data |
| Mutability | Read-only |
| Default | |
Examples
{"id": "1", "name": "Item 1"}
selectedLabel
The label of the selected value, by index.
| Type | string |
| Format | string |
| Mutability | Read-only |
| Default | |
Examples
Value 1
tooltipByIndex
A list of tooltips for each item, by index.
| Type | array |
| Array values | string |
| Mutability | Read-only |
| Default | |
Examples
["Tooltip 1", "Tooltip 2"]
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
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.
radioGroup.clearValidation()
Examples
Clear the validation message from radioGroup.
radioGroup.clearValidation();
radioGroup.clearValue()
Clear the current values.
radioGroup.clearValue()
Examples
Clear the current value of radioGroup.
radioGroup.clearValue();
radioGroup.focus()
Set focus on the input field.
radioGroup.focus()
Examples
Set focus on radioGroup.
radioGroup.focus();
radioGroup.resetValue()
Reset the current value to the default value.
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.
radioGroup.scrollIntoView(options)
Parameters
options Required
The scroll options.
Object Properties
behavior Required
The scroll behavior.
Supported Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block Required
The scroll position relative to the component.
Supported Values
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.
radioGroup.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
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.
radioGroup.setHidden(hidden)
Parameters
hidden
Whether this object is hidden from view.
Examples
Hide radioGroup.
radioGroup.setHidden(true);
Unhide radioGroup.
radioGroup.setHidden(false);
radioGroup.setValue()
Set the current value.
radioGroup.setValue(value)
Parameters
value
The value.
Examples
Set the current value of radioGroup to userValue.
radioGroup.setValue(userValue);
radioGroup.validate()
Validates the value of the input field.
radioGroup.validate()
Examples
Validate the value of radioGroup.
radioGroup.validate();
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.