Custom structural directives in Angular

Introduction

Custom structural directives let you change the layout by adding or removing parts of the page. They help you create reusable and dynamic HTML structures.

You want to show or hide elements based on complex conditions.

You need to repeat a block of HTML with custom logic.

You want to create your own version of *ngIf or *ngFor with special behavior.

You want to add or remove elements dynamically without changing the component code.

Syntax

Angular

import { Directive, TemplateRef, ViewContainerRef, Input } from '@angular/core';

@Directive({
  selector: '[appMyDirective]'
})
export class MyDirective {
  constructor(
    private templateRef: TemplateRef<any>,
    private viewContainer: ViewContainerRef
  ) {}

  @Input() set appMyDirective(condition: boolean) {
    if (condition) {
      this.viewContainer.createEmbeddedView(this.templateRef);
    } else {
      this.viewContainer.clear();
    }
  }
}

TemplateRef is the HTML block you want to control.

ViewContainerRef is where Angular inserts or removes that block.

Examples

This directive shows the element only if the condition is true, similar to *ngIf.

Angular

import { Directive, TemplateRef, ViewContainerRef, Input } from '@angular/core';

@Directive({ selector: '[appShowIf]' })
export class ShowIfDirective {
  constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {}

  @Input() set appShowIf(condition: boolean) {
    if (condition) {
      this.viewContainer.createEmbeddedView(this.templateRef);
    } else {
      this.viewContainer.clear();
    }
  }
}

This directive repeats the element a given number of times.

Angular

import { Directive, TemplateRef, ViewContainerRef, Input } from '@angular/core';

@Directive({ selector: '[appRepeat]' })
export class RepeatDirective {
  constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {}

  @Input() set appRepeat(times: number) {
    this.viewContainer.clear();
    for (let i = 0; i < times; i++) {
      this.viewContainer.createEmbeddedView(this.templateRef);
    }
  }
}

Sample Program

This example creates a custom directive appShowIf that works like *ngIf. Clicking the button toggles the message on and off.

Angular

import { Component, Directive, Input, TemplateRef, ViewContainerRef } from '@angular/core';

@Directive({ selector: '[appShowIf]' })
export class ShowIfDirective {
  constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {}

  @Input() set appShowIf(condition: boolean) {
    if (condition) {
      this.viewContainer.createEmbeddedView(this.templateRef);
    } else {
      this.viewContainer.clear();
    }
  }
}

@Component({
  selector: 'app-root',
  template: `
    <button (click)="toggle()">Toggle Message</button>
    <p *appShowIf="show">Hello! This message is controlled by a custom structural directive.</p>
  `
})
export class AppComponent {
  show = true;

  toggle() {
    this.show = !this.show;
  }
}

Important Notes

Always prefix your directive selectors to avoid conflicts.

Structural directives must use TemplateRef and ViewContainerRef to control DOM.

Use @Input() setter to react to changes in directive input.

Summary

Custom structural directives let you add or remove HTML blocks dynamically.

They use TemplateRef and ViewContainerRef to control the page layout.

You create them by writing a directive with an input property that controls when to show or hide content.

Practice

1. What is the main purpose of a custom structural directive in Angular?

easy

A. To style elements with CSS classes

B. To fetch data from a server

C. To handle user input events

D. To add or remove HTML elements dynamically based on conditions

Solution

1. Step 1: Understand structural directives role

   Structural directives change the structure of the DOM by adding or removing elements.

2. Step 2: Identify the main use case

   Custom structural directives let you control when parts of the page appear or disappear dynamically.

3. Final Answer:

   To add or remove HTML elements dynamically based on conditions -> Option D

4. Quick Check:

   Structural directives = dynamic HTML blocks [OK]

Hint: Structural directives control HTML blocks, not styles or events [OK]

Common Mistakes:

• Confusing structural directives with attribute directives
• Thinking they handle styling or events
• Assuming they fetch data

2. Which of the following is the correct way to inject dependencies in a custom structural directive constructor?

easy

A. constructor(private http: HttpClient) {}

B. constructor(private elementRef: ElementRef, private renderer: Renderer2) {}

C. constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {}

D. constructor(private router: Router) {}

Solution

1. Step 1: Identify dependencies for structural directives

   Structural directives need TemplateRef to access the template and ViewContainerRef to insert or remove views.

2. Step 2: Match constructor parameters

   constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {} correctly injects TemplateRef and ViewContainerRef, which are essential for custom structural directives.

3. Final Answer:

   constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {} -> Option C

4. Quick Check:

   TemplateRef + ViewContainerRef = constructor params [OK]

Hint: Use TemplateRef and ViewContainerRef in constructor for structural directives [OK]

Common Mistakes:

• Injecting ElementRef or Renderer2 which are for attribute directives
• Injecting unrelated services like HttpClient or Router
• Missing TemplateRef or ViewContainerRef

3. Given this directive code snippet, what will be the rendered output if appShowIf input is false?

@Directive({ selector: '[appShowIf]' })
export class ShowIfDirective {
  constructor(private templateRef: TemplateRef<any>, private viewContainer: ViewContainerRef) {}
  @Input() set appShowIf(condition: boolean) {
    if (condition) {
      this.viewContainer.createEmbeddedView(this.templateRef);
    } else {
      this.viewContainer.clear();
    }
  }
}

Usage:

<div *appShowIf="false">Hello World</div>

medium

A. Nothing will be rendered inside the div

B. The text 'Hello World' will be displayed

C. An error will occur because of wrong syntax

D. The div will be rendered but empty

Solution

1. Step 1: Analyze the directive behavior when condition is false

   When appShowIf is false, viewContainer.clear() removes any embedded views, so nothing is rendered.

2. Step 2: Understand the usage effect

   The <div> with 'Hello World' is inside the template controlled by the directive, so it won't appear if condition is false.

3. Final Answer:

   Nothing will be rendered inside the div -> Option A

4. Quick Check:

   False condition = no content shown [OK]

Hint: False input clears view container, so no content appears [OK]

Common Mistakes:

• Thinking the div still renders empty
• Assuming an error occurs
• Confusing attribute directives with structural directives

4. Identify the error in this custom structural directive code:

@Directive({ selector: '[appIf]' })
export class IfDirective {
  constructor(private templateRef: TemplateRef<any>) {}
  @Input() set appIf(condition: boolean) {
    if (condition) {
      this.templateRef.createEmbeddedView();
    }
  }
}

medium

A. Incorrect selector syntax in @Directive decorator

B. Missing ViewContainerRef injection and usage to insert the view

C. Wrong input property name, should be 'appIfCondition'

D. No error, code is correct

Solution

1. Step 1: Check constructor dependencies

   The directive injects only TemplateRef but misses ViewContainerRef, which is needed to insert or clear views.

2. Step 2: Analyze method usage

   Calling createEmbeddedView() on TemplateRef alone is invalid; it should be called on ViewContainerRef with TemplateRef as argument.

3. Final Answer:

   Missing ViewContainerRef injection and usage to insert the view -> Option B

4. Quick Check:

   ViewContainerRef required to add views [OK]

Hint: Always inject ViewContainerRef to add or remove views [OK]

Common Mistakes:

• Trying to create views directly from TemplateRef
• Forgetting to inject ViewContainerRef
• Misnaming input properties

5. You want to create a custom structural directive *appUnless that shows content only when a condition is false. Which implementation correctly achieves this behavior?

hard

A. Use if (!condition) to create the embedded view, else clear it

B. Use if (condition) to create the embedded view, else clear it

C. Always create the embedded view regardless of condition

D. Clear the view only when condition is false

Solution

1. Step 1: Understand the directive goal

   *appUnless should show content only when the condition is false, so the view is created when !condition.

2. Step 2: Match logic to code

   Using if (!condition) to create the embedded view and clearing it otherwise matches the requirement.

3. Final Answer:

   Use if (!condition) to create the embedded view, else clear it -> Option A

4. Quick Check:

   Show content when false = if (!condition) create view [OK]

Hint: Invert condition logic to show content only when false [OK]

Common Mistakes:

• Using if (condition) instead of if (!condition)
• Not clearing the view when condition is true
• Creating view unconditionally