Skip to main content

The Checkbox component for Retool Mobile

An input field to toggle a boolean value.

Demo

Settings​

Checkbox includes the following configurable options when building apps in the IDE.

LabelsCustom ruleDisabledEvent handlersForm data keyHide validation messageShow on desktopShow on mobileLabelMaintain space when hiddenMarginRequiredAlways show in edit modeStylesTypeValueWidth

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.

caption​

string[]

The label for the node.

The custom validation message to display if the invalid is true.

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

events​

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

The type of action to perform.

Values
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).

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

Whether to hide the validation message if the invalid is true.

id​

string

The unique identifier.

invalid​

boolean

Whether the value has failed any validation rules.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

label​

string

The text label to display.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType​

string

The plugin type.

Whether a value is required.

Whether to remain visible in the editor if hidden is true.

style​

object

Custom style options in use. Not all style options may be available for all components.

The type of content or action to perform.

validationMessage​

string

The validation message to display if invalid is true.

value​

boolean

The value.

width​

number

The width.

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.

checkbox.setDisabled(disabled)
Parameters

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

setHidden​

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

checkbox.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

checkbox.setValue(value)
Parameters

value​

boolean

The value.

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​

The value is changed.

false​

The value is set to false.

true​

The value is set to true.