Dynamic component loading in Angular

Introduction

Dynamic component loading lets you add components to your app while it is running. This helps show different content without rebuilding the whole page.

You want to show different widgets based on user choices.

You need to load a popup or modal only when needed.

You want to reduce initial load by loading parts later.

You want to create a dashboard with user-selected panels.

Syntax

Angular

import { Component, ViewContainerRef, ComponentRef, inject } from '@angular/core';

@Component({
  selector: 'app-dynamic-loader',
  template: `<ng-template #container></ng-template>`,
  standalone: true
})
export class DynamicLoaderComponent {
  private viewContainerRef = inject(ViewContainerRef);

  loadComponent(component: any): ComponentRef<any> {
    this.viewContainerRef.clear();
    return this.viewContainerRef.createComponent(component);
  }
}

Use ViewContainerRef to control where the component appears.

Call createComponent() to add the component dynamically.

Examples

Loads MyComponent inside the container.

Angular

this.viewContainerRef.createComponent(MyComponent);

Removes previous components before loading AnotherComponent.

Angular

this.viewContainerRef.clear();
this.viewContainerRef.createComponent(AnotherComponent);

Loads MyComponent and sets an input property.

Angular

const compRef = this.viewContainerRef.createComponent(MyComponent);
compRef.instance.someInput = 'Hello';

Sample Program

This example shows a button that loads a simple component dynamically inside the page when clicked.

Angular

import { Component, ViewContainerRef, inject } from '@angular/core';

@Component({
  selector: 'app-hello',
  template: `<p>Hello, I am a dynamic component!</p>`,
  standalone: true
})
export class HelloComponent {}

@Component({
  selector: 'app-root',
  template: `
    <button (click)="loadHello()">Load Hello Component</button>
    <ng-template #container></ng-template>
  `,
  standalone: true
})
export class AppComponent {
  private viewContainerRef = inject(ViewContainerRef);

  loadHello() {
    this.viewContainerRef.clear();
    this.viewContainerRef.createComponent(HelloComponent);
  }
}

Important Notes

Always clear the container before loading a new component to avoid stacking.

You can pass data to the dynamic component by setting properties on compRef.instance.

Dynamic loading helps keep your app fast by loading only what is needed.

Summary

Dynamic component loading lets you add components while the app runs.

Use ViewContainerRef and createComponent() to load components.

This technique is useful for popups, dashboards, and conditional content.

Practice

1. What is the main purpose of dynamic component loading in Angular?

easy

A. To add components to the view while the app is running

B. To statically declare all components in the template

C. To improve CSS styling of components

D. To replace Angular modules with components

Solution

1. Step 1: Understand dynamic component loading

   Dynamic component loading means adding components to the app view during runtime, not just at compile time.

2. Step 2: Compare options

   Only To add components to the view while the app is running describes adding components while the app runs. Other options describe static or unrelated concepts.

3. Final Answer:

   To add components to the view while the app is running -> Option A

4. Quick Check:

   Dynamic loading = add components at runtime [OK]

Hint: Dynamic loading means adding components during app run [OK]

Common Mistakes:

• Confusing dynamic loading with static template declaration
• Thinking it changes CSS or modules
• Assuming it replaces Angular modules

2. Which Angular service is used to insert a dynamic component into the view?

easy

A. Renderer2

B. HttpClient

C. ViewContainerRef

D. NgModuleRef

Solution

1. Step 1: Identify the service for dynamic insertion

   ViewContainerRef provides a container where components can be dynamically added or removed.

2. Step 2: Eliminate other options

   Renderer2 is for DOM manipulation, HttpClient for HTTP calls, NgModuleRef for module references, none for dynamic component insertion.

3. Final Answer:

   ViewContainerRef -> Option C

4. Quick Check:

   Dynamic insertion uses ViewContainerRef [OK]

Hint: Use ViewContainerRef to insert dynamic components [OK]

Common Mistakes:

• Choosing Renderer2 which is for DOM, not components
• Confusing HttpClient with component loading
• Using NgModuleRef incorrectly

3. Given this code snippet, what will be the output in the browser?

const componentRef = viewContainerRef.createComponent(MyComponent);
componentRef.instance.title = 'Hello';

Assuming MyComponent displays {{ title }} in its template.

medium

A. The component will load but title will be empty

B. The text 'Hello' will appear where the component is loaded

C. Nothing will appear because the component is not attached

D. An error because title is not a valid property

Solution

1. Step 1: Understand createComponent and instance property

   createComponent adds the component to the view. Setting instance.title assigns the property used in the template.

2. Step 2: Predict rendered output

   Since {{ title }} is displayed, and title is set to 'Hello', the text 'Hello' will appear.

3. Final Answer:

   The text 'Hello' will appear where the component is loaded -> Option B

4. Quick Check:

   Set instance property = visible text [OK]

Hint: Setting instance properties updates displayed content [OK]

Common Mistakes:

• Thinking component is not attached after createComponent
• Assuming property must be declared differently
• Ignoring that instance properties affect template

4. What is wrong with this code snippet for dynamic component loading?

@ViewChild('container', { read: ViewContainerRef }) containerRef!: ViewContainerRef;

load() {
  const comp = this.containerRef.createComponent(SomeComponent);
  comp.instance.data = 'Test';
}

medium

A. ViewChild should not use read option

B. Using createComponent without importing ComponentFactoryResolver

C. Cannot assign data property on instance

D. Missing #container template reference in HTML

Solution

1. Step 1: Check ViewChild usage

   ViewChild with #container expects a matching template reference variable in HTML.

2. Step 2: Identify missing template reference

   If #container is missing in the template, containerRef will be undefined, causing runtime errors.

3. Final Answer:

   Missing #container template reference in HTML -> Option D

4. Quick Check:

   ViewChild needs matching template ref [OK]

Hint: Always add matching #ref in template for ViewChild [OK]

Common Mistakes:

• Assuming ComponentFactoryResolver is needed in Angular 14+
• Thinking instance properties can't be assigned
• Misusing read option in ViewChild

5. You want to load different components dynamically based on user input. Which approach correctly handles this scenario in Angular?

hard

A. Use a single ViewContainerRef and call createComponent() with the chosen component type each time, clearing previous components

B. Declare all possible components in the template and use *ngIf to show/hide them

C. Create components manually with new keyword and append to DOM

D. Use Angular modules to switch components dynamically without ViewContainerRef

Solution

1. Step 1: Understand dynamic component switching

   Using ViewContainerRef with createComponent allows loading different components at runtime by clearing old ones and adding new.

2. Step 2: Evaluate other options

   Declare all possible components in the template and use *ngIf to show/hide them is static and less flexible. Create components manually with new keyword and append to DOM bypasses Angular and breaks framework rules. Use Angular modules to switch components dynamically without ViewContainerRef misunderstands modules' role.

3. Final Answer:

   Use a single ViewContainerRef and call createComponent() with the chosen component type each time, clearing previous components -> Option A

4. Quick Check:

   Dynamic switching = clear + createComponent [OK]

Hint: Clear container then create chosen component dynamically [OK]

Common Mistakes:

• Using static *ngIf instead of dynamic loading
• Trying to create components with new keyword
• Confusing modules with dynamic component loading