Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TreeListComponent

Tree List component

For items, use a template named itemTemplate to contain content for each item. If using actions, use a template named actionTemplate to contain expandable content for the actions of each item. Use the loadTemplate to customize lazy loading messages.

Cannot use both multi-select and double click selection at the same time Cannot use both checkbox and click selection at the same time

For angular-tree-component options, see: https://angular2-tree.readme.io/docs

Usage:
import { TreeListModule } from 'patternfly-ng/list';

Or:
import { TreeListModule } from 'patternfly-ng';

Hierarchy

Implements

  • DoCheck
  • OnInit

Index

Constructors

constructor

Properties

actionTemplate

actionTemplate: TemplateRef<any>

The name of the template containing actions for each item

config

The tree list config containing component properties

itemTemplate

itemTemplate: TemplateRef<any>

The name of the template containing item layout

items

items: any[]

An array of items to display in the list

loadTemplate

loadTemplate: TemplateRef<any>

The name of the template containing loading layout

onActionSelect

onActionSelect: EventEmitter<Object> = new EventEmitter()

The event emitted when an action (e.g., button, kebab, etc.) has been selected

onClick

onClick: EventEmitter<Object> = new EventEmitter()

The event emitted when an item has been clicked

onDblClick

onDblClick: EventEmitter<Object> = new EventEmitter()

The event emitted when an item is double clicked

onEvent

onEvent: EventEmitter<Object> = new EventEmitter()

Catch-all event that is triggered for angular-tree-component

onMoveNode

onMoveNode: EventEmitter<Object> = new EventEmitter()

This event is fired any time moveNode is called for angular-tree-component

onSelectionChange

onSelectionChange: EventEmitter<Object> = new EventEmitter()

The event emitted when an item selection has been changed

onToggleExpanded

onToggleExpanded: EventEmitter<Object> = new EventEmitter()

Triggers when expanding / collapsing angular-tree-component nodes

Accessors

itemsEmpty

  • get itemsEmpty(): boolean

Methods

Protected checkboxChange

  • checkboxChange(item: any): void

Protected dblClick

  • dblClick($event: MouseEvent, item: any): void
  • Helper to generate double click event

    Parameters

    • $event: MouseEvent

      The triggered event

    • item: any

      The double clicked item

    Returns void

Protected deselectItems

  • deselectItems(items: any[]): void

Protected getConfig

Protected getSelectedItems

  • getSelectedItems(items: any[]): any[]

Protected handleAction

  • handleAction(action: Action): void

ngDoCheck

  • ngDoCheck(): void

ngOnInit

  • ngOnInit(): void

Protected radioButtonChange

  • radioButtonChange(item: any): void

selectItem

  • selectItem(item: any, selected: boolean): void
  • Select or deselect an item

    Parameters

    • item: any

      The item to select or deselect

    • selected: boolean

      True if item should be selected

    Returns void

Protected selectSingleItem

  • selectSingleItem(item: any): void

Protected setupConfig

  • setupConfig(): void

Protected toggleSelection

  • toggleSelection($event: MouseEvent, item: any): void

update

  • update(): void

Generated using TypeDoc