Building Custom Directives in Angular


While this tutorial has content that we believe is of great benefit to our community, we have not yet tested or edited it to ensure you have an error-free learning experience. It's on our list, and we're working on it! You can help us out by using the "report an issue" button at the bottom of the tutorial.

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.

Defining the directive class

Import Directive, ElementRef and Renderer2 from @angular/core, then use the renderer to set the element’s style to our desired box-shadow value:

Directive: shadow.directive.ts
import { Directive, ElementRef, Renderer2 } from '@angular/core';

Notice how our selector is wrapped in brackets: [appShadow], to properly make it an attribute directive.

Declaring it in our app module

Here’s how you would declare our new directive in the app root module:

App Module: app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { AppComponent } from './app.component';

import { ShadowDirective } from './shadow.directive';

Using the directive in our template

Now it’s as simple as using the attribute directive in our template like so:

App Module: app.component.html
<span appShadow>Alligator</span>

Improving our directive

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:

Directive: shadow.directive.ts
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:

App Module: app.component.html
<span [appShadow]="'hotpink'"

👉 We called our directive appShadow, and not shadow, because it’s a best practice to keep your custom directives scoped to your application.


Creative Commons License