Class IgcTreeItemComponent

The tree-item component represents a child item of the tree component or another tree item.

igc-tree-item

  • Renders nested tree-item component.

label - Renders the tree item container.

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.

wrapper - The wrapper for 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.

Hierarchy

Hierarchy

  • LitElement
    • IgcTreeItemComponent

Other

active: boolean = false

Marks the item as the tree's active item.

disabled: boolean = false

Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions.

expanded: boolean = false

The tree item expansion state.

label: string = ''

The tree item label.

level: number = 0

The depth of the item, relative to the root.

loading: boolean = false

To be used for load-on-demand scenarios in order to specify whether the item is loading data.

parent: null | IgcTreeItemComponent = null

The parent item of the current tree item (if any)

selected: boolean = false

The tree item selection state.

A reference to the tree the item is a part of.

value: any = undefined

The value entry that the tree item is visualizing. Required for searching through items.

lifecycle

  • 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.

    connectedCallback() {
    super.connectedCallback();
    addEventListener('keydown', this._handleKeydown);
    }

    Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

    Returns void

  • 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.

    disconnectedCallback() {
    super.disconnectedCallback();
    window.removeEventListener('keydown', this._handleKeydown);
    }

    An element may be re-connected after being disconnected.

    Returns void

styles

styles: CSSResult[] = ...

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>