Tree Item
<wa-tree-item>
Tree items represent a single hierarchical node inside a tree, and can contain nested items that expand and collapse.
This component must be used as a child of <wa-tree>. Please see the Tree docs to see examples of this component in action.
Importing
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.
Import this component directly from the CDN:
import 'https://ka-f.webawesome.com/webawesome@0.17.0/components/tree-item/tree-item.js';
After installing Web Awesome via npm, import this component:
import '@awesome.me/webawesome/dist/components/tree-item/tree-item.js';
If you're self-hosting Web Awesome, import this component from your server:
import './webawesome/dist/components/tree-item/tree-item.js';
To import this component for React 18 or below, use the following code:
import WaTreeItem from '@awesome.me/webawesome/dist/react/tree-item/index.js';
Slots
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The default slot. |
collapse-icon
|
The icon to show when the tree item is collapsed. |
expand-icon
|
The icon to show when the tree item is expanded. |
Attributes & Properties
Learn more about attributes and properties.
| Name | Description | Reflects |
|---|---|---|
disableddisabled |
Disables the tree item.
Type
boolean
Default
false
|
|
expandedexpanded |
Expands the tree item.
Type
boolean
Default
false
|
|
lazylazy |
Enables lazy loading behavior.
Type
boolean
Default
false
|
|
selectedselected |
Draws the tree item in a selected state.
Type
boolean
Default
false
|
|
Methods
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
getChildrenItems() |
Gets all the nested tree items in this node. |
{ includeDisabled = true }: { includeDisabled?: boolean }
|
Events
Learn more about events.
| Name | Description |
|---|---|
wa-after-collapse |
Emitted after the tree item collapses and all animations are complete. |
wa-after-expand |
Emitted after the tree item expands and all animations are complete. |
wa-collapse |
Emitted when the tree item collapses. |
wa-expand |
Emitted when the tree item expands. |
wa-lazy-change |
Emitted when the tree item's lazy state changes. |
wa-lazy-load |
Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the lazy attribute to remove the loading state and update the tree. |
CSS Custom Properties
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--hide-duration |
The animation duration when collapsing tree items.
Default
var(--wa-transition-normal)
|
--show-duration |
The animation duration when expanding tree items.
Default
var(--wa-transition-normal)
|
Custom States
Learn more about custom states.
| Name | Description | CSS selector |
|---|---|---|
disabled |
Applied when the tree item is disabled. |
:state(disabled)
|
expanded |
Applied when the tree item is expanded. |
:state(expanded)
|
indeterminate |
Applied when the selection is indeterminate. |
:state(indeterminate)
|
selected |
Applied when the tree item is selected. |
:state(selected)
|
CSS Parts
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
base |
The component's base wrapper. |
::part(base)
|
checkbox |
The checkbox that shows when using multiselect. |
::part(checkbox)
|
checkbox__base |
The checkbox's exported base part. |
::part(checkbox__base)
|
checkbox__checked-icon |
The checkbox's exported checked-icon part. |
::part(checkbox__checked-icon)
|
checkbox__control |
The checkbox's exported control part. |
::part(checkbox__control)
|
checkbox__indeterminate-icon |
The checkbox's exported indeterminate-icon part. |
::part(checkbox__indeterminate-icon)
|
checkbox__label |
The checkbox's exported label part. |
::part(checkbox__label)
|
children |
The container that wraps the tree item's nested children. |
::part(children)
|
expand-button |
The container that wraps the tree item's expand button and spinner. |
::part(expand-button)
|
indentation |
The tree item's indentation container. |
::part(indentation)
|
item |
The tree item's container. This element wraps everything except slotted tree item children. |
::part(item)
|
label |
The tree item's label. |
::part(label)
|
spinner |
The spinner that shows when a lazy tree item is in the loading state. |
::part(spinner)
|
spinner__base |
The spinner's base part. |
::part(spinner__base)
|
Dependencies
This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.