CanLoad

Stable Interface

What it does

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

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(
    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 also provide a function with the same signature instead of the class:

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

Interface Overview

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

Interface Description

Interface Details

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

exported from @angular/router/index, defined in @angular/router/src/interfaces.ts

Links:

https://angular.io/docs/ts/latest/api/router/index/CanLoad-interface.html

doc_Angular

2025-01-10 15:47:30

Comments