alfresco-ng2-components/docs/node-favorite.directive.md
Cilibiu Bogdan 892157f01c [ADF-1729] Mark Files and Folders as Favorite (#2466)
* favorite nodes

* removed fdescribe

* use Output over CustomEvent

* EventEmitter any
2017-10-13 10:34:25 +01:00

2.0 KiB

Node Favorite directive

Selectively toggle nodes as favorite

Basic Usage

<adf-toolbar>
    <button md-icon-button
            (toggle)="done()"
            [adf-node-favorite]="documentList.selection">
    </button>
</adf-toolbar>

<adf-document-list #documentList ...>
 ...
</adf-document-list>
@Component({
    selector: 'my-component'
})
export class MyComponent {

    done() {
        // ...
    }

}

Properties

Name Type Default Description
adf-node-favorite MinimalNodeEntity[] [] Nodes to toggle as favorite

Events

Name Description
toggle emitted when toggle favorite process is done

Details

The NodeFavoriteDirective instance can be bound to a template variable through adfFavorite reference, wich provides a method to help further style the element.

<button
    md-menu-item
    #selection="adfFavorite"
    [ngClass]="{ 'icon-highlight': selection.hasFavorites() }"
    [adf-node-favorite]="documentList.selection">
    <md-icon [ngClass]="{ 'icon-highlight': selection.hasFavorites() }">
        {{ selection.hasFavorites() ? 'star' : 'star_border' }}
    </md-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