The Switch mobile component
An input field to toggle a boolean value.
Settings
Switch includes the following configurable options when building apps in the IDE.
CaptionCustom ruleDisabledEvent handlersForm data keyShow on desktopShow on mobileLabelMaintain space when hiddenMarginRequiredAlways show in edit modeStylesValueWidth |
Properties
All properties for Switch with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
customValidation
The custom validation message to display if the invalid
is true
.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
Whether to hide the validation message if the invalid
is true
.
id
The unique identifier.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
validationMessage
The validation message to display if invalid
is true
.
Methods
JavaScript API methods for interacting with Switch. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValidation
Clear the validation message from the input field.
switch.clearValidation()
clearValue
Clear the current values.
switch.clearValue()
focus
Set focus on the input field.
switch.focus()
resetValue
Reset the current value to the default value.
switch.resetValue()
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
switch.setHidden(hidden)
Parameters
toggle
Toggle the current value between true
and false
switch.toggle()
validate
Validates the value of the input field.
switch.validate()
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
change
The value is changed.
false
The value is set to false
.
true
The value is set to true
.