Skip to content

Commit c948218

Browse files
author
Zhivka Dimova
committed
docs(readme): add details for collapse and expand event listeners
1 parent 8d1ecc7 commit c948218

1 file changed

Lines changed: 41 additions & 3 deletions

File tree

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ ng2-tree is a simple [Angular 2](https://github.com/angular/angular) component f
1313
- [Configure node via TreeModelSettings](#configure-node-via-treemodelsettings)
1414
- [[settings]](#settings)
1515
- [`Tree` class](#tree-class)
16-
- [events (nodeMoved, nodeSelected, nodeRenamed, nodeRemoved, nodeCreated)](#events-nodemoved-nodeselected-noderenamed-noderemoved-nodecreated)
16+
- [events (nodeMoved, nodeSelected, nodeRenamed, nodeRemoved, nodeCreated, nodeExpanded, nodeCollapsed)](#events-nodemoved-nodeselected-noderenamed-noderemoved-nodecreated-nodeexpanded-nodecollapsed)
1717
- [NodeSelectedEvent](#nodeselectedevent)
1818
- [NodeMovedEvent](#nodemovedevent)
1919
- [NodeRemovedEvent](#noderemovedevent)
2020
- [NodeCreatedEvent](#nodecreatedevent)
2121
- [NodeRenamedEvent](#noderenamedevent)
22+
- [NodeExpandedEvent](#nodeexpandedevent)
23+
- [NodeCollapsedEvent](#nodecollapsedevent)
2224
- [Changes that should be taken into account in order to migrate from __ng2-tree V1__ to __ng2-tree V2__](#changes-that-should-be-taken-into-account-in-order-to-migrate-from-__ng2-tree-v1__-to-__ng2-tree-v2__)
2325
- [:bulb: Want to help?](#bulb-want-to-help)
2426

@@ -124,7 +126,9 @@ Here is the fully stuffed *tree* tag that you can use in your templates:
124126
(nodeRenamed)="handleRenamed($event)"
125127
(nodeSelected)="handleSelected($event)"
126128
(nodeMoved)="handleMoved($event)"
127-
(nodeCreated)="handleCreated($event)">
129+
(nodeCreated)="handleCreated($event)"
130+
(nodeExpanded)="handleExpanded($event)"
131+
(nodeCollapsed)="handleCollapsed($event)">
128132
</tree>
129133
```
130134

@@ -300,7 +304,7 @@ By default `rootIsVisible` equals to `true`
300304

301305
Also in the next section you'll be reading about events generated by the `ng2-tree`. And here [Tree](src/tree.ts) class comes in handy for us, because its instances propagated with event objects. Under the hood `ng2-tree` wraps a `TreeModel` provided by the user in `Tree`. And `Tree` in turn has lots of useful methods and properties (like `parent`, `hasChild()`, `isRoot()` etc.)
302306

303-
### events (nodeMoved, nodeSelected, nodeRenamed, nodeRemoved, nodeCreated)
307+
### events (nodeMoved, nodeSelected, nodeRenamed, nodeRemoved, nodeCreated, nodeExpanded, nodeCollapsed)
304308

305309
Here is the diagram that shows tree events' hierarchy
306310

@@ -406,6 +410,40 @@ You can subscribe to `NodeRenamedEvent` by attaching listener to `(nodeRenamed)`
406410
}
407411
```
408412

413+
#### NodeExpandedEvent
414+
415+
You can subscribe to `NodeExpandedEvent` by attaching listener to `(nodeExpanded)` attribute, this event wont fire on initial expansion
416+
417+
```html
418+
<tree
419+
[tree]="tree"
420+
(nodeExpanded)="handleExpanded($event)">
421+
</tree>
422+
```
423+
424+
`NodeExpandedEvent` has a `node` property of type `Tree`, which contains an expanded node.
425+
426+
```typescript
427+
{node: <Tree>{...}}
428+
```
429+
430+
#### NodeCollapsedEvent
431+
432+
You can subscribe to `NodeCollapsedEvent` by attaching listener to `(nodeCollapsed)` attribute
433+
434+
```html
435+
<tree
436+
[tree]="tree"
437+
(nodeCollapsed)="handleCollapsed($event)">
438+
</tree>
439+
```
440+
441+
`NodeCollapsedEvent` has a `node` property of type `Tree`, which contains a collapsed node.
442+
443+
```typescript
444+
{node: <Tree>{...}}
445+
```
446+
409447
## Changes that should be taken into account in order to migrate from __ng2-tree V1__ to __ng2-tree V2__
410448
- Events were reworked:
411449
- In V1 all events that were inherited from NodeDestructiveEvent used to have property `parent`. It's not the case anymore. If you need a parent you should get it from `node` in event object like `node.parent`;

0 commit comments

Comments
 (0)