honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add small clarity around navigationCancel (#42282) 

Add small clarity to sentence in documentation for navigation cancel event
to indicate that router guards returning false or urlTree is only one of
several reasons a NavigationCancel event happens.

fixes #26613

PR Close #42282
This commit is contained in:
Andrew Scott 2021-05-24 10:54:15 -07:00 committed by Zach Arend
parent 2ff5bfe139
commit ef33806480
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/router/src/events.ts
View File

@ -134,7 +134,7 @@ export class NavigationEnd extends RouterEvent {
/** /**
* An event triggered when a navigation is canceled, directly or indirectly. * An event triggered when a navigation is canceled, directly or indirectly.
* This can happen when a route guard * This can happen for several reasons including when a route guard
* returns `false` or initiates a redirect by returning a `UrlTree`. * returns `false` or initiates a redirect by returning a `UrlTree`.
* *
* @see `NavigationStart` * @see `NavigationStart`