Skip to main content

Checkbox Tree component for Retool Apps

A group of checkboxes to toggle boolean values in a multi-level tree.

Checkbox Tree is a preset version of Checkbox Group. It has been preconfigured with common options for a nested tree layout.

Retool recently released this improved version of the Checkbox Tree component, and use of the legacy component is discouraged.

Demo

Settings​

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

Show on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties​

All properties for Checkbox Tree with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

captionByIndex​

string

A list of captions for each item, by index.

checkedPathArray​

array[]

The selected items, in nested order.

checkedPathStrings​

string[]

The selected items, in string format.

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

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

data​

any[]

The source data.

The delimiter used in checkedPathStrings.

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

disabledByIndex​

boolean[]

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

disabledValues​

boolean[]

A list of values not available for selection.

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.

The layout of grouped items.

Values
multiColumn

Display items in multiple columns based on the number of items and size.

singleColumn

Always display items in a single column.

wrap

Wrap items.

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

Values
fixed

Fixed height.

auto

Expand to fit content.

​

boolean

Whether the component is visible.

hiddenByIndex​

boolean[]

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

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.

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

Values
dynamic

Options dynamically mapped from an array.

manual

Options manually configured in the IDE.

keyByIndex​

string[]

A list of IDs, by index, for each item.

label​

string

The text label to display.

The horizontal alignment of the label.

Values
left

Left of the input field.

top

Above the input field.

The label for the node.

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

Values
top

Above the input field or value.

left

Left of the input field or value.

labels​

string

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

The label width, in the unit specified in labelWidthUnit.

The specified units for labelWidth, if labelPosition is left.

Values
%

Percent.

px

Pixels.

col

Columns.

Whether the label can wrap to multiple lines.

leafPathArray​

array[]

A list of expanded keys`.

leafPathStrings​

array[]

A list of expanded keys in hyphen-separated format`.

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.

The maximum number of items to allow.

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

The minimum number of items to allow.

The overflow behavior when the contents exceeds the height.

Values
scroll

Display a scrollbar.

pagination

Use pagination.

parentKeyByIndex​

string[]

A list of parent keys for each item, by index.

pluginType​

string

The plugin type.

Whether a value is required.

selectedIndexes​

number[]

A list of selected values, by index.

selectedItems​

object[]

A list of selected items.

selectedLabels​

string[]

A list of labels for selected values, by index.

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.

tooltipByIndex​

string[]

A list of tooltips for each item, by index.

The tooltip text to display.

validationMessage​

string

The validation message to display if invalid is true.

value​

string[] | number[] | boolean[]

The value.

Methods​

blur​

Remove focus from the input field.

checkboxTree.blur()

clearValidation​

Clear the validation message from the input field.

checkboxTree.clearValidation()

clearValue​

Clear the current values.

checkboxTree.clearValue()

focus​

Set focus on the input field.

checkboxTree.focus()

resetValue​

Reset the current value to the default value.

checkboxTree.resetValue()

scrollIntoView​

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

checkboxTree.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions​

object

The scroll options.

Properties

behavior​

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

enum

The scroll position relative to the component.

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

setDisabled​

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

checkboxTree.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.

checkboxTree.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

checkboxTree.setValue(value)
Parameters

value​

string[] | number[] | boolean[]

The value.

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.