Skip to main content

Checkbox Tree component for Retool Apps

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

Demo

Settings​

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

Check strictlyString delimiterDisabledEvent handlersShow on desktopShow on mobileLabelLabel max-widthAlways show label on the leftMaintain space when hiddenMarginAlways show in edit modeStylesHelper text

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.

checked​

object[]

The top level selected items.

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 delimiter used in checkedPathStrings.

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

events​

object[]

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

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

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

The type of action to perform.

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

expanded​

object[]

An array of expanded keys.

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

label​

string

The text label to display.

The maximum label width, in px.

Whether to show the label to the left.

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.

onChange​

The event handler to run when the value changes.

pluginType​

string

The plugin type.

selected​

string[]

A list of checked items.

Whether to remain visible in the editor if hidden is true.

structure​

object

A nested array of possible values.

style​

object

Custom style options in use. Not all style options may be available for all components.

The tooltip text to display.

Methods​

JavaScript API methods for interacting with Checkbox Tree. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

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.

setChecked​

Toggle which items are true.

checkboxTree.setChecked(setCheckedOptions)
Parameters

setCheckedOptions​

number[]

A list of items, by index, to set as checked.

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.