CanDeactivate

Stable

Interface

What it does

Indicates that a class can implement to be a guard deciding if a route can be deactivated.

How to use

class UserToken {} class Permissions { canDeactivate(user: UserToken, id: string): boolean { return true; } } @Injectable() class CanDeactivateTeam implements CanDeactivate<TeamComponent> { constructor(private permissions: Permissions, private currentUser: UserToken) {} canDeactivate( component: TeamComponent, route: ActivatedRouteSnapshot, state: RouterStateSnapshot ): Observable<boolean>|Promise<boolean>|boolean { return this.permissions.canDeactivate(this.currentUser, route.params.id); } } @NgModule({ imports: [ RouterModule.forRoot([ { path: 'team/:id', component: TeamCmp, canDeactivate: [CanDeactivateTeam] } ]) ], providers: [CanDeactivateTeam, 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, canActivate: ['canDeactivateTeam'] } ]) ], providers: [ { provide: 'canDeactivateTeam', useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => true } ] }) class AppModule {}

Interface Overview

interface CanDeactivate {
canDeactivate(component: T, route: ActivatedRouteSnapshot, state: RouterStateSnapshot) : Observable<boolean>|Promise<boolean>|boolean

}

Interface Description

Interface Details

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