Building directives in Angular 2+ is not much different than building components. After all, components are just directives with a view attached. In fact, there are three kinds of directives in Angular: components, attribute directives and structural directives.
Structural directives add or remove elements from the DOM. NgIf, ngFor and ngSwitch are examples of built-in structural directives. Attribute directives are used to change the styling or behavior of elements.
Let’s learn how to create a custom attribute directive with an example with a appShadow directive.
Import Directive, ElementRef and Renderer2 from @angular/core, then use the renderer to set the element’s style to our desired box-shadow value:
import { Directive, ElementRef, Renderer2 } from '@angular/core';
Notice how our selector is wrapped in brackets: [appShadow], to properly make it an attribute directive.
Here’s how you would declare our new directive in the app root module:
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import { ShadowDirective } from './shadow.directive';
Now it’s as simple as using the attribute directive in our template like so:
<span appShadow>Alligator</span>
Our appShadow directive is a bit dumb, and we could have applied a shadow simply with a style binding instead. Let’s therefore make it better by allowing to pass values to our directive:
import { Directive, ElementRef, Input, Renderer2, OnInit } from '@angular/core';
@Directive({ selector: '[appShadow]' })
export class ShadowDirective implements OnInit {
@Input() appShadow: string;
@Input() appShadowX: string;
@Input() appShadowY: string;
@Input() appShadowBlur: string;
constructor(private elem: ElementRef, private renderer: Renderer2) { }
ngOnInit() {
let shadowStr = `${ this.appShadowX } ${ this.appShadowY } ${ this.appShadowBlur } ${ this.appShadow }`;
this.renderer.setStyle(this.elem.nativeElement, 'box-shadow', shadowStr);
}
We used inputs to pass data from our component template to the directive. Notice also how we’re using the OnInit lifecycle hook now instead of doing the work in the constructor. That’s because our inputs don’t have any value at construction time.
You can now have full control over the shadow:
<span [appShadow]="'hotpink'"
[appShadowX]="'12px'"
[appShadowY]="'6px'"
[appShadowBlur]="'30px'">Alligator</span>
👉 We called our directive appShadow, and not shadow, because it’s a best practice to keep your custom directives scoped to your application.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
Alligator.io is a developer-focused resource that offers tutorials and insights on a wide range of modern front-end technologies, including Angular 2+, Vue.js, React, TypeScript, Ionic, and JavaScript.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.
Full documentation for every DigitalOcean product.
The Wave has everything you need to know about building a business, from raising funding to marketing your product.
Stay up to date by signing up for DigitalOcean’s Infrastructure as a Newsletter.
New accounts only. By submitting your email you agree to our Privacy Policy
Scale up as you grow — whether you're running one virtual machine or ten thousand.
Sign up and get $200 in credit for your first 60 days with DigitalOcean.*
*This promotional offer applies to new accounts only.