The Switch component for Retool Mobile

An input field to toggle a boolean value.

Version: Cloud and 3.185 Edge

Demo

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
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Caption

---

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

type

The type of content or action to perform.

Type	string
Mutability	Control Usage Retool UI Inspector

---

value

The current value or the default value.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Content > Default value Method setValue()
Default	false

Examples

true

---

width

The width.

Type	string
Format	Integer
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description full Full width. fixed Fixed width.

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()

Clear the validation message from the input field.

Definition

switch.clearValidation()

Examples

Clear the validation message from switch.

switch.clearValidation();

---

switch.clearValue()

Clear the current values.

Definition

switch.clearValue()

Examples

Clear the current value of switch.

switch.clearValue();

---

switch.focus()

Set focus on the input field.

Definition

switch.focus()

Examples

Set focus on switch.

switch.focus();

---

switch.resetValue()

Reset the current value to the default value.

Definition

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.

Definition

switch.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

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.

Definition

switch.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide switch.

switch.setHidden(true);

Unhide switch.

switch.setHidden(false);

---

switch.setValue()

Sets the value of the checkbox.

Definition

switch.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of switch to userValue.

switch.setValue(userValue);

---

switch.toggle()

Toggle the current value between true and false.

Definition

switch.toggle()

Examples

Toggle the current value of switch.

switch.toggle();

---

switch.validate()

Validates the value of the input field.

Definition

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.