Skip to main content

The Switch component for Retool Apps

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.

disabled​

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Disabled
MethodsetDisabled()
Default
false
Examples
true

id​

The unique identifier (name).

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector
Default
switch1
Examples
query1
button1

isHiddenOnDesktop​

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on desktop
Default
false
Examples
true

isHiddenOnMobile​

Whether to show or hide this object in the mobile layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on mobile
Default
true
Examples
true

labelPosition​

The position of the label relative to the input field or value.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Position
Allowed Values
ValueUI OptionDescription
topTop

Above the input field or value.

leftLeft

Left of the input field or value.

Default
left
Examples
top

maintainSpaceWhenHidden​

Whether to take up space on the canvas if hidden is true.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default
false
Examples
true

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default
4px 8px
Examples
4px 8px

required​

Whether a value is required to be selected.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Validation rules > Required
Default
false
Examples
true

showInEditor​

Whether the component remains visible in the editor if hidden is true.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default
false
Examples
true

style​

Custom style options.

Type object
Mutability
ControlUsage
Retool UI Inspector > Appearance > style

tooltipText​

The tooltip text to display next to the label on hover.

Type string
Format Markdown
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Helper text
Default
null
Examples
Submit

value​

The current value.

Type boolean
Mutability Read-only

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.scrollIntoView()​

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition
switch.scrollIntoView(options)
Parameters

options​

The scroll options.

Type object
Object Properties

behavior​

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
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 switch into view.

switch.scrollIntoView({behavior: 'auto', block: 'nearest'});

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

Set the current value.

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

Events​

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

EventDescription
ChangeThe value is changed.
FalseThe value is set to false.
TrueThe value is set to true.