The Checkbox mobile component
An input field to toggle a boolean value.
Settings
Checkbox includes the following configurable options when building apps in the IDE.
Properties
All properties for Checkbox with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
labelCaption
The additional text to display with the label.
customValidation
The custom validation message to display if the invalid is true.
Properties
event
The event type.
Values
0
A user changes the value.
1
A user clicks or taps the component.
2
A user submits the value.
3
A user selects the input field.
4
A user deselects the input field.
5
A user scans a barcode.
6
A user opens the component.
7
A user closes the component.
8
A user sets the value to true.
9
A user sets the value to false.
10
A user selects a value.
11
A user clears the value.
12
A user uploads a file.
13
An uploaded file is parsed.
14
A user changes the value of the input field.
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.
Values
0
Control query.
1
Control component.
2
Run script.
3
Set variable.
4
Set localStorage.
5
Perform utility action (e.g., Open URL or Confetti).
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
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 name.
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 Checkbox. 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.
checkbox.clearValidation()
clearValue
Clear the current values.
checkbox.clearValue()
focus
Set focus on the input field.
checkbox.focus()
resetValue
Reset the current value to the default value.
checkbox.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.
checkbox.setHidden(hidden)
Parameters
toggle
Toggle the current value between true and false
checkbox.toggle()
validate
Validates the value of the input field.
checkbox.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
A user changes the current value.
false
A user sets the current value to false.
true
A user sets the current value to true.