The Checkbox Group component for Retool Mobile

A group of checkboxes to toggle boolean values.

Version: Self-hosted 3.114 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.

disabled

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

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

Examples

true

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance Method setHidden()
Default	false

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
Default	null

Examples

"Label"

---

labelCaption

The additional text to display with the label.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label

---

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Label 1", "Label 2", "Label 3"]

---

type

The type of content or action to perform.

Type	string
Mutability	Control Usage Retool UI Inspector

---

value

The value.

Type	array
Array values	string
Mutability	Read-only

---

values

A list of possible values from which to select.

Type	array
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.

checkboxGroup.clearValidation()

Clear the validation message from the input field.

Definition

checkboxGroup.clearValidation()

Examples

Clear the validation message from checkboxGroup.

checkboxGroup.clearValidation();

---

checkboxGroup.clearValue()

Clear the current values.

Definition

checkboxGroup.clearValue()

Examples

Clear the current value of checkboxGroup.

checkboxGroup.clearValue();

---

checkboxGroup.focus()

Set focus on the input field.

Definition

checkboxGroup.focus()

Examples

Set focus on checkboxGroup.

checkboxGroup.focus();

---

checkboxGroup.resetValue()

Reset the current value to the default value.

Definition

checkboxGroup.resetValue()

Examples

Reset the current value of checkboxGroup.

checkboxGroup.resetValue();

---

checkboxGroup.setDisabled()

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

Definition

checkboxGroup.setDisabled(disabled)

Parameters

disabled

boolean

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

Examples

Disable checkboxGroup.

checkboxGroup.setDisabled(true);

Enable checkboxGroup.

checkboxGroup.setDisabled(false);

---

checkboxGroup.setHidden()

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

Definition

checkboxGroup.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide checkboxGroup.

checkboxGroup.setHidden(true);

Unhide checkboxGroup.

checkboxGroup.setHidden(false);

---

checkboxGroup.setValue()

Set the current value.

Definition

checkboxGroup.setValue(value)

Parameters

value

string | number | boolean | object | array

The value.

Examples

Set the current value of checkboxGroup to userValue.

checkboxGroup.setValue(userValue);

---

checkboxGroup.validate()

Validates the value of the input field.

Definition

checkboxGroup.validate()

Examples

Validate the value of checkboxGroup.

checkboxGroup.validate();

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---