This is the archived documentation for Angular v5. Please visit angular.io to see documentation for the current version of Angular.

CanLoad

npm Package @angular/router
Module import { CanLoad } from '@angular/router';
Source router/src/interfaces.ts

Interface that a class can implement to be a guard deciding if a children can be loaded.

Interface Overview

      
      interface CanLoad { 
  canLoad(route: Route): Observable<boolean> | Promise<boolean> | boolean
}

How To Use

      
      class UserToken {}
class Permissions {
  canLoadChildren(user: UserToken, id: string): boolean {
    return true;
  }
}

@Injectable()
class CanLoadTeamSection implements CanLoad {
  constructor(private permissions: Permissions, private currentUser: UserToken) {}

  canLoad(route: Route): Observable<boolean>|Promise<boolean>|boolean {
    return this.permissions.canLoadChildren(this.currentUser, route);
  }
}

@NgModule({
  imports: [
    RouterModule.forRoot([
      {
        path: 'team/:id',
        component: TeamCmp,
        loadChildren: 'team.js',
        canLoad: [CanLoadTeamSection]
      }
    ])
  ],
  providers: [CanLoadTeamSection, UserToken, Permissions]
})
class AppModule {}

You can alternatively provide a function with the canLoad signature:

      
      @NgModule({
  imports: [
    RouterModule.forRoot([
      {
        path: 'team/:id',
        component: TeamCmp,
        loadChildren: 'team.js',
        canLoad: ['canLoadTeamSection']
      }
    ])
  ],
  providers: [
    {
      provide: 'canLoadTeamSection',
      useValue: (route: Route) => true
    }
  ]
})
class AppModule {}

Members

      
      canLoad(route: Route): Observable<boolean> | Promise<boolean> | boolean