Toggle Button
A button to toggle a boolean value. It supports changing an icon based on the value.
Properties
Available properties for Toggle Button with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
The current value.
Whether user input, interaction, or selection is disabled.
Whether the component is visible.
The horizontal alignment of the contents.
The icon to display when value
is false
.
The icon to display when value
is true
.
The position of the icon relative to the label.
The position of the loading indicator if loading
is true
.
Whether to display a loading indicator.
Whether the component takes up space on the canvas if hidden
is true
.
The amount of margin to render outside of the component.
Whether the component remains visible in the editor if hidden
is true
.
The primary text content.
The text to display in a tooltip on hover or focus.
Events
Events are triggered by user interactions with Toggle Button. Use event handling to trigger queries or other actions in response to events.
A user changes the current value.
A user sets the current value to false
.
A user sets the current value to true
.
Methods
Methods for interacting with Toggle Button. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.
Set the current value.
Toggle the current value between true
and false
.
Clear the current value.
Scrolls the canvas or parent container so that the selected component appears in the visible area.
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
Reset value
to the default value.