The Checkbox component for Retool Mobile

An input field to toggle a boolean value.

Version: Self-hosted 3.196 Stable

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.

caption

The additional text to display with the label.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Caption

---

disabled

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Disabled
Default	false

Examples

true

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

type

The type of content or action to perform.

Type	string
Configurability	Inspector

---

value

The current value or the default value.

Type	boolean
Format	True/False
Configurability	Inspector > Content > Default value
Default	false

Examples

true

---

width

The width.

Type	string
Format	Integer
Configurability	Inspector
Allowed Values	Value Description full Full width. fixed Fixed width.

Examples

1280

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

checkbox.clearValidation()

Clear the validation message from the input field.

Definition

checkbox.clearValidation()

Examples

Clear the validation message from checkbox.

checkbox.clearValidation();

---

checkbox.clearValue()

Clear the current values.

Definition

checkbox.clearValue()

Examples

Clear the current value of checkbox.

checkbox.clearValue();

---

checkbox.focus()

Set focus on the input field.

Definition

checkbox.focus()

Examples

Set focus on checkbox.

checkbox.focus();

---

checkbox.resetValue()

Reset the current value to the default value.

Definition

checkbox.resetValue()

Examples

Reset the current value of checkbox.

checkbox.resetValue();

---

checkbox.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

checkbox.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable checkbox.

checkbox.setDisabled(true);

Enable checkbox.

checkbox.setDisabled(false);

---

checkbox.setHidden()

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

Definition

checkbox.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide checkbox.

checkbox.setHidden(true);

Unhide checkbox.

checkbox.setHidden(false);

---

checkbox.setValue()

Sets the value of the checkbox.

Definition

checkbox.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of checkbox to userValue.

checkbox.setValue(userValue);

---

checkbox.toggle()

Toggle the current value between true and false.

Definition

checkbox.toggle()

Examples

Toggle the current value of checkbox.

checkbox.toggle();

---

checkbox.validate()

Validates the value of the input field.

Definition

checkbox.validate()

Examples

Validate the value of checkbox.

checkbox.validate();

---

Events

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

Event	Description
Change	The value is changed.
False	The value is set to false.
True	The value is set to true.