Toggle a boolean value.
A checkbox to toggle a boolean value.
Properties
Available properties for Mobile Checkbox. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
customValidation string
A JavaScript conditional statement for custom validation logic. If customValidation evaluates to a string, validation fails and it is rendered as the the error message. An empty or nullish value is treated as valid input.
disabled boolean
If true, the component will be greyed out and non-interactive, and the value cannot be modified
formDataKey string
When inside a Form, this key is used to pull the default value from form.initialData and construct the form.data property
id string
The name of the component.
invalid boolean
Whether the current value has failed any validation rules
label string
A text label for the input.
labelCaption string
The additional text to display with the label.
labels string[]
An optional array of labels for each value. The value will be displayed when a label is not provided.
pluginType string
The component type.
required boolean
If true, a value must be provided to be valid.
validationMessage string
The message to be rendered when the input is invalid.
value (string │ number │ boolean │ null │ undefined)
The value of the component.
values (string │ number │ boolean │ null │ undefined)[]
An array of possible values.