The Checkbox component for Retool Apps

An input field to toggle a boolean value.

Version: Cloud and 3.185 Edge

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.

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	checkbox1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Required
Default	false

Examples

true

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The value.

Type	boolean
Mutability	Read-only

---

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()

Set the current value.

Definition

checkbox.setValue(value)

Parameters

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.