The Switch component for Retool Mobile
An input field to toggle a boolean 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.
caption
The additional text to display with the label.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Caption |
| Default | null |
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
true
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
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 |
| Default | null |
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 |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
true
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
"Label"
value
The current value or the default value.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Content > Default value |
| Default | false |
Examples
true
width
The width.
| Type | string | ||||||
| Format | Integer | ||||||
| Configurability | Inspector | ||||||
| Allowed Values |
| ||||||
| Default | null |
Examples
1280
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
switch.clearValidation()
Examples
Clear the validation message from switch.
switch.clearValidation();
switch.clearValue()
Examples
Clear the current value of switch.
switch.clearValue();
switch.focus()
Examples
Set focus on switch.
switch.focus();
switch.resetValue()
Examples
Reset the current value of switch.
switch.resetValue();
switch.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
switch.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable switch.
switch.setDisabled(true);
Enable switch.
switch.setDisabled(false);
switch.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
switch.setHidden(hidden)
Parameters
Examples
true
Examples
Hide switch.
switch.setHidden(true);
Unhide switch.
switch.setHidden(false);
switch.setValue(key, value)
Examples
Set the current value of switch to userValue.
switch.setValue(userValue);
switch.toggle()
Examples
Toggle the current value of switch.
switch.toggle();
switch.validate()
Examples
Validate the value of switch.
switch.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.
| Event | Description |
|---|---|
| Change | The value is changed. |
| False | The value is set to false. |
| True | The value is set to true. |