What it does
Interface that a class can implement to be a guard deciding if a child route can be
activated.
How to use
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>|Promise<boolean>|boolean {
return this.permissions.canActivate(this.currentUser, route.params.id);
}
}
@NgModule({
imports: [
RouterModule.forRoot([
{
path: 'root',
canActivateChild: [CanActivateTeam],
children: [
{
path: 'team/:id',
component: Team
}
]
}
])
],
providers: [CanActivateTeam, UserToken, Permissions]
})
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: Team
}
]
}
])
],
providers: [
{
provide: 'canActivateTeam',
useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => true
}
]
})
class AppModule {}
Interface Overview
interface CanActivateChild {canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot) : Observable<boolean>|Promise<boolean>|boolean
}
Interface Details
canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot) : Observable<boolean>|Promise<boolean>|boolean
exported from router/index,
defined in router/src/interfaces.ts