@finastra/filter-tree
TypeScript icon, indicating that this package has built-in type declarations

1.8.1 • Public • Published

FilterTree

The fds-filter-tree provides a tree that could be used to display hierarchy data.

See it on NPM! How big is this package in your project? Storybook

Usage

Import

npm i @finastra/filter-tree
import '@finastra/filter-tree';
...
<fds-filter-tree items=[
  {
    label: 'Consumer Banking',
    children: [
      {
        label: 'Alerts',
        isSelected: true
      },
      {
        label: 'Customer Management'
      }
    ],
  },
  {
    label: 'Money Movement'
  },
  {
    label: 'Financial Toolbox'
  }
]>
</fds-filter-tree>

API

Properties

Property Attribute Type Default Description
items items treenode[] [] List of items.

Methods

Method Type
checkDescendants (item: treenode, indexInTreeNode: any): void
checkIndeterminate (nodeEl: HTMLElement): void
descendantsAllSelected (node: flattreenode): boolean
descendantsPartiallySelected (node: flattreenode): boolean
deselectChildren (items: treenode[]): void
findIndex (node: flattreenode): any
flatTreeTransformer (items: treenode[], level: number | undefined, flatTreeTransf: flattreenode[]): flattreenode[]
getDescendants (node: flattreenode): flattreenode[]
getNodeElementById (id: string): any
getParentNode (node: flattreenode): flattreenode | null
haveChildren (item: treenode): boolean
init (items: treenode[]): void
initSelection (item: treenode, indexInTreeNode: any): void
isSelected (node: flattreenode): boolean
notifyParent (node: flattreenode): void
onExpandClick (item: treenode, index: number, event: CustomEvent<any>): void
onRequestSelected (item: treenode, index: number, event: CustomEvent<any>): void
onSelect (item: treenode, nodeEl: HTMLElement, indexInTreeNode: number, indexInFlatTreeNode: number, eventType: string): void
renderChildren (items: treenode[]): any
selectChildren (items: treenode[]): void
toFlatTreeNode (item: treenode, index: any): flattreenode

Events

Event Type
filter-tree-check CustomEvent<treestate>

Package Sidebar

Install

npm i @finastra/filter-tree

Weekly Downloads

5

Version

1.8.1

License

MIT

Unpacked Size

63.1 kB

Total Files

30

Last publish

Collaborators

  • david.bocle
  • ffdcbot
  • ttalbot