The tree-item component represents a child item of the tree component or another tree item. Find-in-page, a text fragment or a link to an element in the children of a collapsed item expands it.
- Slots
-
default— Renders nested tree-item component. -
label— Renders the content of the tree item, in place of the `label` property. -
indicator— Renders the expand indicator container. -
loading— Renders the tree item loading indicator container. -
indentation— Renders the container (by default the space) before the tree item.
- CSS Parts
-
wrapper— The wrapper for the tree item. -
indentation— The indentation area before the tree item. -
selected— Indicates selected state. Applies to `wrapper`. -
focused— Indicates focused state. Applies to `wrapper`. -
active— Indicates an active state. Applies to `wrapper`. -
indicator— The expand indicator of the tree item. -
label— The tree item content. -
text— The tree item displayed text. -
select— The checkbox of the tree item when selection is enabled.
Properties
Section titled "Properties"active
Section titled "active"Whether the item is the active item of the tree. When true, the ancestors of the item expand.
active: boolean disabled
Section titled "disabled"Whether the tree item is disabled. A disabled item does not respond to user interaction.
disabled: boolean loading
Section titled "loading"Whether the item is loading data, for load-on-demand scenarios. The item shows a loading indicator in place of the expand indicator.
loading: boolean parent
Section titled "parent"The parent item of the current tree item (if any)
parent: IgrTreeItemComponent | null value
Section titled "value"The value that the tree item represents. The component does not use it.
value: any Accessors
Section titled "Accessors"The full path to the tree item, starting from the top-most ancestor.
get path(): IgrTreeItemComponent[]
Returns IgrTreeItemComponent[]
A reference to the tree the item is a part of.
get tree(): IgrTreeComponent | undefined
Returns IgrTreeComponent | undefined
Methods
Section titled "Methods"collapse
Section titled "collapse"Collapses the tree item.
collapse(): void Returns void
connectedCallback
Section titled "connectedCallback"Invoked when the component is added to the document's DOM.
In connectedCallback() you should setup tasks that should only occur when
the element is connected to the document. The most common of these is
adding event listeners to nodes external to the element, like a keydown
event handler added to the window.
``
Typically, anything done in connectedCallback() should be undone when the
element is disconnected, in disconnectedCallback().
connectedCallback(): void Returns void
disconnectedCallback
Section titled "disconnectedCallback"Invoked when the component is removed from the document's DOM.
This callback is the main signal to the element that it may no longer be
used. disconnectedCallback() should ensure that nothing is holding a
reference to the element (such as event listeners added to nodes external
to the element), so that it is free to be garbage collected.
``
An element may be re-connected after being disconnected.
disconnectedCallback(): void Returns void
expand
Section titled "expand"Expands the tree item.
expand(): void Returns void
getChildren
Section titled "getChildren"Returns the child items. With flatten: true it returns all the
descendant items, otherwise only the direct children.
getChildren(options: object): IgrTreeItemComponent[] Parameters
- options:
object
Returns IgrTreeItemComponent[]
toggle
Section titled "toggle"Toggles tree item expansion state.
toggle(): void