Les "Attribute Directives" permettent de modifier le comportement d'un élément, un composant ou une autre directive.
Les directives sont déclarés quasiment de la même façon qu'un composant sauf qu'elles n'ont pas de template.
{% tabs %} {% tab title="highlight.directive.ts" %}
@Directive({
selector: '[wtHighlight]'
})
export class HighlightDirective {
}{% endtab %} {% endtabs %}
{% hint style="warning" %}
La directive doit ensuite être ajoutée aux declarations (et exports) du module associé (qui doit être importé par les modules contenant les composants qui l'utilisent).
@NgModule({
declarations: [
HighlightDirective
],
exports: [
HighlightDirective
]
})
...{% endhint %}
{% hint style="success" %}
La convention est d'utiliser des sélecteurs à base d'attributs : [wtHighlight].
Les noms d'attributs doivent être préfixés avec le préfixe de votre application (e.g. wt).
Evitez les sélecteurs à base de classes CSS ou tag HTML. {% endhint %}
Les directives peuvent être générées à l'aide d'Angular CLI.
yarn ng generate directive --export highlightLa "Dependency Injection" permet de récupérer via la classe ElementRef, une référence vers l'objet permettant de manipuler l'élément DOM associé.
{% tabs %} {% tab title="highlight.directive.ts" %}
@Directive({
selector: '[wtHighlight]'
})
export class HighlightDirective implements OnInit {
constructor(private _elementRef: ElementRef) {
}
ngOnInit() {
this._elementRef.nativeElement.style.backgroundColor = 'red';
}
}{% endtab %} {% endtabs %}
Pour appliquer une directive à un élément, il suffit de lui ajouter l'attribut indiqué dans le selector de la directive.
{% hint style="warning" %} Si le module contenant la directive n'est pas importé, la directive ne sera pas activée sur l'élément et Angular ne produit aucune erreur car pour ce dernier il ne s'agit que d'un attribut superflu. {% endhint %}
{% tabs %} {% tab title="book-preview.component.html" %}
<h1 wtHighlight>{{ book.title }}</h1>
{% endtab %} {% endtabs %}
@HostListener() est un décorateur permettant d'ajouter un "listener" sur l'élément sur lequel la directive est appliquée ("host element").
{% tabs %} {% tab title="highlight.directive.ts" %}
@Directive({
selector: '[wtHighlight]'
})
export class HighlightDirective {
constructor(private _elementRef: ElementRef) {
}
@HostListener('mouseenter') applyBackgroundColor() {
this._setBackgroundColor('red');
}
@HostListener('mouseleave') removeBackgroundColor() {
this._setBackgroundColor(null);
}
private _setBackgroundColor(color: string) {
this._elementRef.nativeElement.style.backgroundColor = color;
}
}{% endtab %} {% endtabs %}
Les directives peuvent être personnalisés avec des @Input() et il est également possible de remonter des événements au composant parent via des @Output().
{% tabs %} {% tab title="highlight.directive.ts" %}
@Directive({
selector: '[wtHighlight]'
})
export class HighlightDirective {
@Input() color = 'red';
constructor(private _elementRef: ElementRef) {
}
@HostListener('mouseenter') applyBackgroundColor() {
this._setBackgroundColor(this.color);
}
@HostListener('mouseleave') removeBackgroundColor() {
this._setBackgroundColor(null);
}
private _setBackgroundColor(color: string) {
this._elementRef.nativeElement.style.backgroundColor = color;
}
}{% endtab %} {% endtabs %}
La directive peut alors être utilisée de la façon suivante :
<h1 wtHighlight [color]="getBookHighlightColor(book)">{{ book.title }}</h1>
{% hint style="info" %}
A condition que cela n'introduise pas d'ambigüité, il est possible d'utiliser l'attribut de la directive comme @Input().
@Input('wtHighlight') color = 'red';La directive peut alors être utilisée ainsi :
<h1 [wtHighlight]="getBookHighlightColor(book)">{{ book.title }}</h1>
ou si la valeur est un string :
<h1 wtHighlight="red">{{ book.title }}</h1>
{% endhint %}