Skip to main content

Tree

Ant Design

The Tree component is Ant Design's tree view. It shows nested items, such as folders, categories or an org chart, that users expand, select and optionally check.

Properties​

Property
Description
Expected Value
Tree dataThe nodes, each with a title, a unique key and optional children, such as [{ title: 'Projects', key: 'projects', children: [...] }].Array
CheckableShows a checkbox on each node. Checking a parent checks all its children.On or off. Default: Off
Expand allOpens every branch when the tree first shows.On or off. Default: On
Show lineDraws lines that connect each node to its parent.On or off. Default: Off
Checked keysKeys of the checked nodes. It updates as the user checks and unchecks nodes.Array

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On selectTriggers when the user selects or deselects a node.
On checkTriggers when the user checks or unchecks a node.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.tree1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.tree1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.tree1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
treeDataThe nodes, each with a title, a unique key and optional children, such as [{ title: 'Projects', key: 'projects', children: [...] }].{{components.tree1.treeData}}
checkableShows a checkbox on each node. Checking a parent checks all its children.{{components.tree1.checkable}}
defaultExpandAllOpens every branch when the tree first shows.{{components.tree1.defaultExpandAll}}
showLineDraws lines that connect each node to its parent.{{components.tree1.showLine}}
checkedKeysKeys of the checked nodes. It updates as the user checks and unchecks nodes.{{components.tree1.checkedKeys}}
selectedKeysKeys of the selected nodes, such as ['website'].{{components.tree1.selectedKeys}}
isVisibleWhether the component is visible.{{components.tree1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.tree1.isLoading}}
isDisabledWhether the component is disabled.{{components.tree1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.