Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/router

CanActivateChild

Interface that a class can implement to be a guard deciding if a child route can be activated. If all guards return true, navigation will continue. If any guard returns false, navigation will be cancelled. If any guard returns a UrlTree, current navigation will be cancelled and a new navigation will be kicked off to the UrlTree returned from the guard.

See more...

      
      interface CanActivateChild {
  canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree
}

Description

class UserToken {} class Permissions { canActivate(user: UserToken, id: string): boolean { return true; } } @Injectable() class CanActivateTeam implements CanActivateChild { constructor(private permissions: Permissions, private currentUser: UserToken) {} canActivateChild( route: ActivatedRouteSnapshot, state: RouterStateSnapshot ): Observable<boolean|UrlTree>|Promise<boolean|UrlTree>|boolean|UrlTree { return this.permissions.canActivate(this.currentUser, route.params.id); } } @NgModule({ imports: [ RouterModule.forRoot([ { path: 'root', canActivateChild: [CanActivateTeam], children: [ { path: 'team/:id', component: TeamComponent } ] } ]) ], providers: [CanActivateTeam, UserToken, Permissions] }) class AppModule {} 
      
      
  1. class UserToken {}
  2. class Permissions {
  3.   canActivate(user: UserToken, id: string): boolean {
  4.     return true;
  5.   }
  6. }
  7.  
  8. @Injectable()
  9. class CanActivateTeam implements CanActivateChild {
  10.   constructor(private permissions: Permissions, private currentUser: UserToken) {}
  11.  
  12.   canActivateChild(
  13.     route: ActivatedRouteSnapshot,
  14.     state: RouterStateSnapshot
  15.   ): Observable<boolean|UrlTree>|Promise<boolean|UrlTree>|boolean|UrlTree {
  16.     return this.permissions.canActivate(this.currentUser, route.params.id);
  17.   }
  18. }
  19.  
  20. @NgModule({
  21.   imports: [
  22.     RouterModule.forRoot([
  23.       {
  24.         path: 'root',
  25.         canActivateChild: [CanActivateTeam],
  26.         children: [
  27.           {
  28.              path: 'team/:id',
  29.              component: TeamComponent
  30.           }
  31.         ]
  32.       }
  33.     ])
  34.   ],
  35.   providers: [CanActivateTeam, UserToken, Permissions]
  36. })
  37. class AppModule {}

You can alternatively provide a function with the canActivateChild signature:

@NgModule({ imports: [ RouterModule.forRoot([ { path: 'root', canActivateChild: ['canActivateTeam'], children: [ { path: 'team/:id', component: TeamComponent } ] } ]) ], providers: [ { provide: 'canActivateTeam', useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => true } ] }) class AppModule {} 
      
      
  1. @NgModule({
  2.   imports: [
  3.     RouterModule.forRoot([
  4.       {
  5.         path: 'root',
  6.         canActivateChild: ['canActivateTeam'],
  7.         children: [
  8.           {
  9.             path: 'team/:id',
  10.             component: TeamComponent
  11.           }
  12.         ]
  13.       }
  14.     ])
  15.   ],
  16.   providers: [
  17.     {
  18.       provide: 'canActivateTeam',
  19.       useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => true
  20.     }
  21.   ]
  22. })
  23. class AppModule {}

Methods

canActivateChild()

canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree
      
      canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree
Parameters
childRoute ActivatedRouteSnapshot
state RouterStateSnapshot
Returns

Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree