The Checkbox Group component for Retool Apps

A group of checkboxes to toggle boolean values.

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.

captionByIndex

A list of captions for each item, by index.

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

Examples

["Caption 1", "Caption 2"]

---

checkedPathArray

The selected items, in nested order.

Type	array
Array values	number
Mutability	Read-only

---

checkedPathStrings

The selected items, in strong format.

Type	array
Array values	string
Mutability	Read-only

---

checkStrictly

Whether to check the treeNode. Parent treeNode and children treeNodes are not included.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

delimiter

The delimiter used in checkedPathStrings.

Type	string
Mutability	Control Usage Retool UI Inspector

---

deprecatedLabels

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"]

---

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

---

disabledByIndex

A list of values for each item, by index, that reflect whether they are disabled.

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

Examples

[true, false, true]

---

disabledValues

A list of values not available for selection.

Type	array
Array values	boolean
Mutability	Read-only

---

groupLayout

The layout of grouped items.

Type	string
Mutability	Control Usage Retool UI Inspector > Appearance > Group layout
Allowed Values	Value UI Option Description multiColumn Tree Display items in multiple columns based on the number of items and size. singleColumn Single column Always display items in a single column. wrap Wrap Wrap items. tree
Default	auto

---

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Height
Allowed Values	Value Description auto Expand to fit content. fixed Fixed height. fill
Default	fixed

---

hiddenByIndex

A list of items, by index, and whether they are hidden.

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

Examples

[true, false, true]

---

id

The unique identifier (name).

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

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

---

labelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

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"]

---

leafPathArray

A list of expanded keys.

Type	array
Array values	string
Mutability	Read-only

---

leafPathStrings

A list of expanded keys in hyphen-separated format.

Type	array
Array values	string
Mutability	Read-only

---

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

---

maxCount

The maximum number of items to allow.

Type	number
Mutability	Control Usage Retool UI Inspector

---

minColumnWidth

The minimum width of a column when using a multi-column layout.

Type	number
Format	number
Mutability	Control Usage Retool UI Inspector > Appearance > Min col width
Default	null

Examples

100

---

minCount

The minimum number of items to allow.

Type	number
Mutability	Control Usage Retool UI Inspector

---

parentKeysByIndex

A list of parent keys, by index.

Type	array
Array values	string
Mutability	Read-only

---

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

---

selectedIndexes

A list of selected values, by index.

Type	array
Array values	number
Mutability	Read-only

---

selectedItems

A list of selected items.

Type	array
Mutability	Read-only
Default	[]

Examples

[{"id": "1", "name": "Item 1"}, {"id": "2", "name": "Item 2"}]

---

selectedLabels

A list of labels for selected values, by index.

Type	array
Array values	string
Mutability	Read-only

---

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

---

tooltipByIndex

A list of tooltips for each item, by index.

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

Examples

["Tooltip 1", "Tooltip 2"]

---

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	array
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.blur()

Remove focus from the input field.

Definition

checkboxGroup.blur()

Examples

Remove focus from checkboxGroup.

checkboxGroup.blur();

---

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

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

checkboxGroup.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring checkboxGroup into view.

checkboxGroup.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

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

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

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

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide checkboxGroup.

checkboxGroup.setHidden(true);

Unhide checkboxGroup.

checkboxGroup.setHidden(false);

---

checkboxGroup.setValue()

Set the current value.

Definition

checkboxGroup.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of checkboxGroup to userValue.

checkboxGroup.setValue(userValue);

---

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.