inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs for directives (#2964)

Browse Source
This commit is contained in:
Andy Stark
2018-02-20 14:00:18 +00:00
committed by Eugenio Romano
parent d731cc651c
commit b45048b5ed
26 changed files with 137 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/node-favorite.directive.md
+10 -11
View File
@@ -32,15 +32,15 @@ export class MyComponent {
### Properties
| Name | Type | Default | Description |
| ----------------- | ------------------- | ------- | --------------------------- |
| adf-node-favorite | MinimalNodeEntity[] | [] | Nodes to toggle as favorite |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| selection | `MinimalNodeEntity[]` | `[]` | Array of nodes to toggle as favorites. |
### Events
| Name | Description |
| ------------------------- | -------------------------------------------- |
| toggle | emitted when toggle favorite process is done |
| Name | Type | Description |
| ---- | ---- | ----------- |
| toggle | `EventEmitter<any>` | Emitted when the favorite setting is complete. |
## Details
@@ -61,10 +61,9 @@ which provides a method to help further style the element.
The directive performs as follows:
- if there are no favorite nodes in the selection, then all are marked as favorites
- if there is at least one favorite node in the selection, then only those who are not
are being marked
- if all nodes in the selection are favorites, then they are removed from favorites
- if there are no favorite nodes in the selection, then all are marked as favorites
- if there is at least one favorite node in the selection, then only those who are not
are being marked
- if all nodes in the selection are favorites, then they are removed from favorites
See **Demo Shell**