mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
4752f3b73e
* [ADF-2334] Added version and status metadata to doc files * [ADF-2334] Tidier looking metadata for guide pages
74 lines
1.7 KiB
Markdown
74 lines
1.7 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# Node Favorite directive
|
|
|
|
Selectively toggles nodes as favorite
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-toolbar>
|
|
<button mat-icon-button
|
|
(toggle)="done()"
|
|
[adf-node-favorite]="documentList.selection">
|
|
</button>
|
|
</adf-toolbar>
|
|
|
|
<adf-document-list #documentList ...>
|
|
...
|
|
</adf-document-list>
|
|
```
|
|
|
|
```ts
|
|
@Component({
|
|
selector: 'my-component'
|
|
})
|
|
export class MyComponent {
|
|
|
|
done() {
|
|
// ...
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| selection | `MinimalNodeEntity[]` | `[]` | Array of nodes to toggle as favorites. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| toggle | `EventEmitter<any>` | Emitted when the favorite setting is complete. |
|
|
|
|
## Details
|
|
|
|
The `NodeFavoriteDirective` instance can be bound to a template variable through **adfFavorite** reference,
|
|
which provides a method to help further style the element.
|
|
|
|
```html
|
|
<button
|
|
mat-menu-item
|
|
#selection="adfFavorite"
|
|
[ngClass]="{ 'icon-highlight': selection.hasFavorites() }"
|
|
[adf-node-favorite]="documentList.selection">
|
|
<mat-icon [ngClass]="{ 'icon-highlight': selection.hasFavorites() }">
|
|
{{ selection.hasFavorites() ? 'star' : 'star_border' }}
|
|
</mat-icon>
|
|
</button>
|
|
```
|
|
|
|
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
|
|
|
|
See **Demo Shell**
|