docs: add detail to router event doc (#32140)

PR Close #32140
This commit is contained in:
Judy Bogart 2019-08-14 11:04:26 -07:00 committed by atscott
parent ef2047555a
commit e3f42818e9
2 changed files with 6 additions and 2 deletions

View File

@ -519,7 +519,8 @@ During each navigation, the `Router` emits navigation events through the `Router
<td> <td>
An [event](api/router/NavigationCancel) triggered when navigation is canceled. An [event](api/router/NavigationCancel) triggered when navigation is canceled.
This is due to a [Route Guard](#guards) returning false during navigation. This can happen when a [Route Guard](#guards) returns false during navigation,
or redirects by returning a `UrlTree`.
</td> </td>
</tr> </tr>

View File

@ -122,7 +122,10 @@ export class NavigationEnd extends RouterEvent {
} }
/** /**
* An event triggered when a navigation is canceled. * An event triggered when a navigation is canceled, directly or indirectly.
*
* This can happen when a [route guard](guide/router#milestone-5-route-guards)
* returns `false` or initiates a redirect by returning a `UrlTree`.
* *
* @publicApi * @publicApi
*/ */