An Angular treeview component with checkbox
npm install ngxs-dropdown-treeOriginally forked from: https://github.com/leovo2708/ngx-treeview
I've updated the packages to support angular 9 and fixed the breaking changes and added few new features like
* Display selected items on the button.
* Delete selected items from button itself by clicking small (x) icon.
* If the number of selected items are more than 5, it will display "2 more..." (inspired by ng-select component).
Note: The changes done are purely, to meet my project's requirements only. You can fork this and make changes to meet your requirements.
ngxs-dropdown-tree via:
shell
npm install ngxs-dropdown-tree --save
`
Once installed you need to import our main module in your application module:
`js
import { TreeviewModule } from 'ngxs-dropdown-tree';
@NgModule({
declarations: [AppComponent, ...],
imports: [TreeviewModule.forRoot(), ...],
bootstrap: [AppComponent]
})
export class AppModule {
}
`
Usage
#### Treeview:
`html
[items]="items"
(selectedChange)="onSelectedChange($event)"
(filterChange)="onFilterChange($event)">
`
#### Treeview with dropdown:
`html
[config]="config"
[items]="items"
(selectedChange)="onSelectedChange($event)"
(filterChange)="onFilterChange($event)">
`
config is optional. This is the default configuration:
`js
{
hasAllCheckBox: true,
hasFilter: false,
hasCollapseExpand: false,
decoupleChildFromParent: false,
maxHeight: 500
}
`
You can change default configuration easily because TreeviewConfig is injectable.
#### Pipe ngxsTreeview:
To map your JSON objects to TreeItem objects.
`html
[items]="items | ngxsTreeview:'textField'"
(selectedChange)="onSelectedChange($event)">
`
#### Create a TreeviewItem:
`js
const itCategory = new TreeviewItem({
text: 'IT', value: 9, children: [
{
text: 'Programming', value: 91, children: [{
text: 'Frontend', value: 911, children: [
{ text: 'Angular 1', value: 9111 },
{ text: 'Angular 2', value: 9112 },
{ text: 'ReactJS', value: 9113 }
]
}, {
text: 'Backend', value: 912, children: [
{ text: 'C#', value: 9121 },
{ text: 'Java', value: 9122 },
{ text: 'Python', value: 9123, checked: false }
]
}]
},
{
text: 'Networking', value: 92, children: [
{ text: 'Internet', value: 921 },
{ text: 'Security', value: 922 }
]
}
]
});
`
You can pass the second paramater 'autoCorrectChecked' with value=true (default is false) in constructor of TreeviewItem to correct checked value of it and all of its descendants. In some cases, you need to push or pop children flexibly, checked of parent may be not correct. Then you need to call function correctChecked() to help to correct from root to its descendants.
`js
const vegetableCategory = new TreeviewItem({
text: 'Vegetable', value: 2, children: [
{ text: 'Salad', value: 21 },
{ text: 'Potato', value: 22 }
]
});
vegetableCategory.children.push(new TreeviewItem({ text: 'Mushroom', value: 23, checked: false }));
vegetableCategory.correctChecked(); // need this to make 'Vegetable' node to change checked value from true to false
``