Help Angular by taking a 1 minute survey!Go to surveyHome

CanActivate

Interface that a class can implement to be a guard deciding if a 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 CanActivate {
  canActivate(route: 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 CanActivate { constructor(private permissions: Permissions, private currentUser: UserToken) {} canActivate( 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: 'team/:id', component: TeamComponent, canActivate: [CanActivateTeam] } ]) ], 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 CanActivate {
  10. constructor(private permissions: Permissions, private currentUser: UserToken) {}
  11.  
  12. canActivate(
  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: 'team/:id',
  25. component: TeamComponent,
  26. canActivate: [CanActivateTeam]
  27. }
  28. ])
  29. ],
  30. providers: [CanActivateTeam, UserToken, Permissions]
  31. })
  32. class AppModule {}

You can alternatively provide a function with the canActivate signature:

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

Methods

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

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