The Toggle Button component for Retool Apps
A toggle button to trigger different actions when clicked.
For more information about using the Toggle Button component, refer to the buttons and links guide.
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.
ariaLabel
The accessible label for screen readers.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
"Retool logo."
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
true
hidden
Whether this object is hidden from view.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
true
horizontalAlign
The horizontal alignment of the contents.
Type | string | ||||||||
Format | Plain Text | ||||||||
Mutability |
| ||||||||
Allowed Values |
| ||||||||
Default |
|
iconForFalse
The icon to display when value
is false
.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
/icon:bold/interface-arrows-button-down
iconForTrue
The icon to display when value
is true
.
Type | string | ||||
Format | Icon Key | ||||
Mutability |
| ||||
Default |
|
Examples
/icon:bold/interface-arrows-button-up
id
The unique identifier (name).
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
loaderPosition
The position of the loading indicator if loading
is true
.
Type | string | ||||||||||
Mutability |
| ||||||||||
Allowed Values |
| ||||||||||
Default |
|
loading
Whether to display a loading indicator.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
4px 8px
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
style
Custom style options.
Type | object | ||||
Mutability |
|
styleVariant
The style variant to use.
Type | string | ||||||
Format | Plain Text | ||||||
Mutability |
| ||||||
Allowed Values |
| ||||||
Default |
|
Examples
solid
text
The primary text content.
Type | string | ||||
Format | Plain Text | ||||
Mutability |
|
Examples
Submit
value
The current value or the default value.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
true
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
toggleButton.clearValue()
Clear the current values.
toggleButton.clearValue()
Examples
Clear the current value of toggleButton
.
toggleButton.clearValue();
toggleButton.resetValue()
Reset the current value to the default value.
toggleButton.resetValue()
Examples
Reset the current value of toggleButton
.
toggleButton.resetValue();
toggleButton.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
toggleButton.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring toggleButton
into view.
toggleButton.scrollIntoView({behavior: 'auto', block: 'nearest'});
toggleButton.setDisabled()
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
toggleButton.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Default |
|
Examples
true
Examples
Disable toggleButton
.
toggleButton.setDisabled(true);
Enable toggleButton
.
toggleButton.setDisabled(false);
toggleButton.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
toggleButton.setHidden(hidden)
Parameters
Examples
true
Examples
Hide toggleButton
.
toggleButton.setHidden(true);
Unhide toggleButton
.
toggleButton.setHidden(false);
toggleButton.setValue()
Set the current value.
toggleButton.setValue(value)
Examples
Set the current value of toggleButton
to userValue
.
toggleButton.setValue(userValue);
toggleButton.toggle()
Toggle the current value between true
and false
.
toggleButton.toggle()
Examples
Toggle the current value of toggleButton
.
toggleButton.toggle();
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
Event | Description |
---|---|
Change | The value is changed. |
False | The value is set to false . |
True | The value is set to true . |