Tree Item
<cs-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 <cs-tree>. Please see the Tree docs to see examples of this component in action.
API
Importing
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.
import '@cruglobal/cornerstone-components/components/tree-item/tree-item.js';
import './cornerstone/components/tree-item/tree-item.js';
import CsTreeItem from '@cruglobal/cornerstone-components/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.
| Property | Attribute | Description | Type | Default | Reflects |
|---|---|---|---|---|---|
disabled | disabled | Disables the tree item. | boolean | false | Yes |
expanded | expanded | Expands the tree item. | boolean | false | Yes |
lazy | lazy | Enables lazy loading behavior. | boolean | false | Yes |
selected | selected | Draws the tree item in a selected state. | boolean | false | Yes |
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 |
|---|---|
cs-after-collapse | Emitted after the tree item collapses and all animations are complete. |
cs-after-expand | Emitted after the tree item expands and all animations are complete. |
cs-collapse | Emitted when the tree item collapses. |
cs-expand | Emitted when the tree item expands. |
cs-lazy-change | Emitted when the tree item's lazy state changes. |
cs-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 | Default |
|---|---|---|
--hide-duration | The animation duration when collapsing tree items. | var(--cs-transition-normal) |
--show-duration | The animation duration when expanding tree items. | var(--cs-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 |
|---|---|---|
checkbox | The checkbox that shows when using multiselect. | ::part(checkbox) |
checkbox__checkbox | The checkbox's exported checkbox part. | ::part(checkbox__checkbox) |
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__spinner | The spinner's exported spinner part. | ::part(spinner__spinner) |
tree-item | The component's outer wrapper. | ::part(tree-item) |
Dependencies
This component automatically imports the following elements. Sub-dependencies, if any exist, are included in this list.