Lazy loading modules with routes in Angular - Mini Project: Build & Apply

Lazy Loading Modules with Routes in Angular

📖 Scenario: You are building a simple Angular app that has two sections: Home and About. To make the app faster, you want to load the About section only when the user visits it. This technique is called lazy loading.

🎯 Goal: Create an Angular app with two modules: HomeModule and AboutModule. Set up routing so that the AboutModule is lazy loaded when the user navigates to the /about path.

📋 What You'll Learn

Create a HomeModule with a HomeComponent that shows 'Welcome to Home!'

Create an AboutModule with an AboutComponent that shows 'About Us Information'

Set up the main app routing to load HomeModule eagerly at path '' (empty path)

Set up the main app routing to lazy load AboutModule at path 'about'

Use Angular standalone components and standalone routing where appropriate

💡 Why This Matters

🌍 Real World

Lazy loading modules helps large Angular apps load faster by splitting code into smaller chunks that load only when needed.

💼 Career

Understanding lazy loading and routing is essential for Angular developers to build efficient, scalable web applications.

1

Create HomeModule with HomeComponent

Create a standalone Angular component called HomeComponent that displays the text 'Welcome to Home!'. Then create a standalone Angular module called HomeModule that declares and exports HomeComponent.

Angular

// Create HomeComponent and HomeModule here
// Your code here

Hint

Use @Component with standalone: true for HomeComponent. Then create a module class called HomeModule that imports and exports HomeComponent.

2

Create AboutModule with AboutComponent

Create a standalone Angular component called AboutComponent that displays the text 'About Us Information'. Then create a standalone Angular module called AboutModule that declares and exports AboutComponent.

Angular

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

@Component({
  selector: 'app-home',
  standalone: true,
  template: `Welcome to Home!`
})
export class HomeComponent {}

@NgModule({
  declarations: [],
  imports: [HomeComponent],
  exports: [HomeComponent]
})
export class HomeModule {}

// Create AboutComponent and AboutModule here
// Your code here

Hint

Similar to HomeComponent, create AboutComponent with standalone true and a simple template. Then create AboutModule that imports and exports AboutComponent.

3

Set up main app routing with lazy loading

Create an Angular routing configuration array called routes. Add a route with path '' that loads HomeComponent eagerly. Add a route with path 'about' that lazy loads AboutModule using dynamic import syntax.

Angular

import { Routes } from '@angular/router';

// Create routes array with eager HomeComponent and lazy AboutModule
const routes: Routes = [
  // Your code here
];

Hint

Define routes as an array. Use component: HomeComponent for the empty path. Use loadChildren with dynamic import for the 'about' path.

4

Add RouterModule with routes to AppModule

Create an Angular module called AppModule. Import RouterModule.forRoot(routes) and export RouterModule. This sets up the router with the routes you defined.

Angular

import { RouterModule } from '@angular/router';

@NgModule({
  imports: [RouterModule.forRoot(routes)],
  exports: [RouterModule]
})
export class AppModule {}

// Your code here

Hint

Import RouterModule.forRoot(routes) in AppModule imports array and export RouterModule.

Practice

1. What is the main purpose of lazy loading modules in Angular routing?

easy

A. To preload all modules when the app starts

B. To load modules only when the user navigates to their route

C. To load modules in alphabetical order

D. To load all modules at once for faster navigation

Solution

1. Step 1: Understand lazy loading concept

   Lazy loading means delaying the loading of a module until it is needed, usually when the user navigates to a route that requires it.

2. Step 2: Identify the purpose in routing

   In Angular routing, lazy loading helps improve app speed by loading modules only on demand, not all at once.

3. Final Answer:

   To load modules only when the user navigates to their route -> Option B

4. Quick Check:

   Lazy loading = load on demand [OK]

Hint: Lazy loading means load modules only when needed [OK]

Common Mistakes:

• Thinking lazy loading loads all modules at start
• Confusing lazy loading with preloading
• Assuming lazy loading loads modules alphabetically

2. Which of the following is the correct syntax to lazy load a module named AdminModule in Angular routes?

easy

A. { path: 'admin', loadChildren: import('./admin/admin.module') }

B. { path: 'admin', loadChildren: './admin/admin.module#AdminModule' }

C. { path: 'admin', component: AdminModule }

D. { path: 'admin', loadChildren: () => import('./admin/admin.module').then(m => m.AdminModule) }

Solution

1. Step 1: Recall Angular lazy loading syntax

   Angular uses dynamic import with a function returning a promise that resolves to the module class.

2. Step 2: Match syntax to options

   { path: 'admin', loadChildren: () => import('./admin/admin.module').then(m => m.AdminModule) } uses the correct arrow function with import and then to get AdminModule. { path: 'admin', loadChildren: './admin/admin.module#AdminModule' } is old deprecated string syntax. Options C and D are incorrect usage.

3. Final Answer:

   { path: 'admin', loadChildren: () => import('./admin/admin.module').then(m => m.AdminModule) } -> Option D

4. Quick Check:

   Dynamic import with arrow function = correct syntax [OK]

Hint: Use arrow function with import().then() for lazy loading [OK]

Common Mistakes:

• Using deprecated string syntax for loadChildren
• Assigning component instead of loadChildren
• Omitting the arrow function wrapper

3. Given this route configuration snippet:

{ path: 'shop', loadChildren: () => import('./shop/shop.module').then(m => m.ShopModule) }

What happens when the user navigates to /shop for the first time?

medium

A. The ShopModule is already loaded at app start, so navigation is instant

B. Navigation fails because loadChildren requires a component

C. The ShopModule is loaded asynchronously and its routes are activated

D. The entire app reloads to load ShopModule

Solution

1. Step 1: Understand lazy loading behavior on navigation

   When navigating to a lazy loaded route for the first time, Angular loads the module asynchronously.

2. Step 2: Identify what happens on first navigation

   The ShopModule is fetched, loaded, and its routes become active, enabling the user to see the shop page.

3. Final Answer:

   The ShopModule is loaded asynchronously and its routes are activated -> Option C

4. Quick Check:

   First navigation triggers async module load [OK]

Hint: First visit loads module asynchronously, not at app start [OK]

Common Mistakes:

• Assuming module loads at app start
• Confusing loadChildren with component property
• Thinking app reloads on lazy load

4. Identify the error in this Angular route configuration for lazy loading:

{ path: 'dashboard', loadChildren: './dashboard/dashboard.module#DashboardModule' }

medium

A. Using string syntax for loadChildren is deprecated and causes errors

B. Missing component property for the route

C. Path should be capitalized as 'Dashboard'

D. loadChildren should be a component, not a string

Solution

1. Step 1: Check loadChildren syntax

   The string syntax with '#ModuleName' is deprecated in Angular and may cause errors in recent versions.

2. Step 2: Identify correct syntax

   Modern Angular requires loadChildren to be a function returning a dynamic import promise, not a string.

3. Final Answer:

   Using string syntax for loadChildren is deprecated and causes errors -> Option A

4. Quick Check:

   Use dynamic import function, not string [OK]

Hint: Avoid string syntax; use dynamic import function [OK]

Common Mistakes:

• Using old string syntax for loadChildren
• Confusing component and loadChildren properties
• Ignoring case sensitivity in paths

5. You want to lazy load a feature module ProfileModule only when the user navigates to /profile. The module has child routes. Which is the best way to configure the main app routing to achieve this and ensure accessibility and performance?

hard

A. { path: 'profile', loadChildren: () => import('./profile/profile.module').then(m => m.ProfileModule), canActivate: [AuthGuard] }

B. { path: 'profile', component: ProfileModule }

C. { path: 'profile', loadChildren: () => import('./profile/profile.module').then(m => m.ProfileModule) }

D. { path: 'profile', loadChildren: './profile/profile.module#ProfileModule' }

Solution

1. Step 1: Identify modern lazy loading syntax

   The correct syntax uses dynamic import with an arrow function returning a promise: loadChildren: () => import('./profile/profile.module').then(m => m.ProfileModule).

2. Step 2: Consider best practices for accessibility and performance

   For protected features like a user profile, adding canActivate: [AuthGuard] ensures secure access while lazy loading maintains performance.

3. Step 3: Eliminate incorrect configurations

   Using component property fails for modules with child routes. String syntax like './profile/profile.module#ProfileModule' is deprecated.

4. Final Answer:

   { path: 'profile', loadChildren: () => import('./profile/profile.module').then(m => m.ProfileModule), canActivate: [AuthGuard] } -> Option A

5. Quick Check:

   Lazy load with guard for best practice [OK]

Hint: Lazy load with import and add guards for security [OK]

Common Mistakes:

• Using component instead of loadChildren for modules
• Using deprecated string syntax
• Forgetting route guards for protected routes