Class BootstrapTreeView

Tree view component built using the Bootstrap (v5) framework.

The component makes use of Bootstrap Icons, so classes such as bi-folder or bi-clock can be used in INode's icon property.

Hierarchy

TreeView
- BootstrapTreeView

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BootstrapTreeView(container: HTMLElement, options: ITreeViewOptions): BootstrapTreeView

Inherited from TreeView.constructor
- Defined in TreeView.ts:84
Initializes a new tree view.

Parameters
- container: HTMLElement
  
  HTML element that will host the tree view.
- options: ITreeViewOptions
  
  Additional options.
Returns BootstrapTreeView

Properties

Protected container

container: HTMLElement

Protected Optional onSelectionChanged

onSelectionChanged: (nodes: INode[]) => void

Type declaration

- (nodes: INode[]): void
- Parameters
  - nodes: INode[]
  Returns void

Protected provider

provider: IDataProvider

Protected root

root: HTMLElement

Methods

Protected attach

attach(): void

Inherited from TreeView.attach
- Defined in TreeView.ts:95
Attaches the tree view to the DOM.

Returns void

Protected detach

detach(): void

Inherited from TreeView.detach
- Defined in TreeView.ts:104
Detaches the tree view from the DOM.

Returns void

Protected onNodeClicked

onNodeClicked(node: INode, el: HTMLElement): void

Overrides TreeView.onNodeClicked
- Defined in BootstrapTreeView.ts:58
Reacts to the event of a tree node being clicked.

Parameters
- node: INode
  
  Tree node metadata.
- el: HTMLElement
  
  Tree node HTML element.
Returns void

Protected onNodeCollapsed

onNodeCollapsed(node: INode, el: HTMLElement): void

Overrides TreeView.onNodeCollapsed
- Defined in BootstrapTreeView.ts:81
Reacts to the event of a tree node being collapsed.

Parameters
- node: INode
  
  Tree node metadata.
- el: HTMLElement
  
  Tree node HTML element.
Returns void

Protected onNodeExpanded

onNodeExpanded(node: INode, el: HTMLElement): void

Overrides TreeView.onNodeExpanded
- Defined in BootstrapTreeView.ts:92
Reacts to the event of a tree node being expanded.

Parameters
- node: INode
  
  Tree node metadata.
- el: HTMLElement
  
  Tree node HTML element.
Returns void

Protected onNodeLoading

onNodeLoading(node: INode, el: HTMLElement): void

Overrides TreeView.onNodeLoading
- Defined in BootstrapTreeView.ts:70
Reacts to the event of a tree node loading its children.

Parameters
- node: INode
  
  Tree node metadata.
- el: HTMLElement
  
  Tree node HTML element.
Returns void

Protected renderNode

renderNode(node: INode): HTMLElement

Overrides TreeView.renderNode
- Defined in BootstrapTreeView.ts:16
Creates new HTML representation of a tree node.

abstract

Parameters
- node: INode
  
  Input tree node.
Returns HTMLElement

New block-based HTML element.

Generated using TypeDoc