The tree allows users to represent hierarchical data in a tree-view structure, maintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model.
- Element
-
igc-tree
- Slots
-
default— Renders the tree items inside default slot.
Constructors
Section titled "Constructors"IgcTreeComponent
new IgcTreeComponent(): IgcTreeComponentDefined in src/components/tree/tree.ts:146
Returns IgcTreeComponent
Properties
Section titled "Properties"selection
Section titled "selection"The selection state of the tree.
selection: TreeSelection = 'none'Defined in src/components/tree/tree.ts:83
singleBranchExpand
Section titled "singleBranchExpand"Whether a single or multiple of a parent's child items can be expanded.
singleBranchExpand: boolean = falseDefined in src/components/tree/tree.ts:69
toggleNodeOnClick
Section titled "toggleNodeOnClick"Whether clicking over nodes will change their expanded state or not.
toggleNodeOnClick: boolean = falseDefined in src/components/tree/tree.ts:76
tagName
Section titled "tagName"The tagName read-only property of the Element interface returns the tag name of the element on which it's called.
tagName: "igc-tree" = 'igc-tree'Defined in src/components/tree/tree.ts:43
Accessors
Section titled "Accessors"items
Section titled "items"Returns all of the tree's items.
get items(): IgcTreeItemComponent[]Defined in src/components/tree/tree.ts:175
Returns IgcTreeItemComponent[]
locale
Section titled "locale"Gets/Sets the locale used for getting language, affecting resource strings.
set locale(value: string): voidDefined in src/components/tree/tree.ts:90
Parameters
- value:
string
Returns void
resourceStrings
Section titled "resourceStrings"get resourceStrings(): ITreeResourceStringsDefined in src/components/tree/tree.ts:107
Returns ITreeResourceStrings
The resource strings for localization. Currently only aria-labels of the default expand/collapse icons are localized for the tree item.
set resourceStrings(value: ITreeResourceStrings): voidDefined in src/components/tree/tree.ts:103
Parameters
- value:
ITreeResourceStrings
Returns void
Methods
Section titled "Methods"addEventListener
Section titled "addEventListener"Inherited from: EventEmitterMixin< IgcTreeComponentEventMap, Constructor<LitElement> >(LitElement)
addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): voidDefined in src/components/common/mixins/event-emitter.ts:7
Parameters
- type:
K - listener:
object - options:
boolean | AddEventListenerOptions
Returns void
collapse
Section titled "collapse"Collapses all of the passed items. If no items are passed, collapses ALL items.
collapse(items: IgcTreeItemComponent[]): voidDefined in src/components/tree/tree.ts:240
Parameters
- items:
IgcTreeItemComponent[]
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(): voidDefined in src/components/tree/tree.ts:157
Returns void
deselect
Section titled "deselect"Deselect all items if the items collection is empty. Otherwise, deselect the items in the items collection.
deselect(items: IgcTreeItemComponent[]): voidDefined in src/components/tree/tree.ts:213
Parameters
- items:
IgcTreeItemComponent[]
Returns void
emitEvent
Section titled "emitEvent"Inherited from: EventEmitterMixin< IgcTreeComponentEventMap, Constructor<LitElement> >(LitElement)
emitEvent(type: K, eventInitDict: CustomEventInit<D>): booleanDefined in src/components/common/mixins/event-emitter.ts:30
Parameters
- type:
K - eventInitDict:
CustomEventInit<D>
Returns boolean
expand
Section titled "expand"Expands all of the passed items. If no items are passed, expands ALL items.
expand(items: IgcTreeItemComponent[]): voidDefined in src/components/tree/tree.ts:225
Parameters
- items:
IgcTreeItemComponent[]
Returns void
removeEventListener
Section titled "removeEventListener"Inherited from: EventEmitterMixin< IgcTreeComponentEventMap, Constructor<LitElement> >(LitElement)
removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): voidDefined in src/components/common/mixins/event-emitter.ts:17
Parameters
- type:
K - listener:
object - options:
boolean | EventListenerOptions
Returns void
select
Section titled "select"Select all items if the items collection is empty. Otherwise, select the items in the items collection.
select(items: IgcTreeItemComponent[]): voidDefined in src/components/tree/tree.ts:196
Parameters
- items:
IgcTreeItemComponent[]
Returns void
register
Section titled "register"register(): voidDefined in src/components/tree/tree.ts:47
Returns void
Events
Section titled "Events"igcActiveItem
Section titled "igcActiveItem"igcActiveItem: CustomEvent<IgcTreeItemComponent>Defined in src/components/tree/tree.common.ts:11
igcItemCollapsed
Section titled "igcItemCollapsed"igcItemCollapsed: CustomEvent<IgcTreeItemComponent>Defined in src/components/tree/tree.common.ts:10
igcItemCollapsing
Section titled "igcItemCollapsing"igcItemCollapsing: CustomEvent<IgcTreeItemComponent>Defined in src/components/tree/tree.common.ts:9
igcItemExpanded
Section titled "igcItemExpanded"igcItemExpanded: CustomEvent<IgcTreeItemComponent>Defined in src/components/tree/tree.common.ts:8
igcItemExpanding
Section titled "igcItemExpanding"igcItemExpanding: CustomEvent<IgcTreeItemComponent>Defined in src/components/tree/tree.common.ts:7
igcSelection
Section titled "igcSelection"igcSelection: CustomEvent<IgcTreeSelectionEventArgs>Defined in src/components/tree/tree.common.ts:6