From ef3380648042df9eb80d711068c528b016d2a569 Mon Sep 17 00:00:00 2001 From: Andrew Scott Date: Mon, 24 May 2021 10:54:15 -0700 Subject: [PATCH] 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 --- packages/router/src/events.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/router/src/events.ts b/packages/router/src/events.ts index ff98a594bb..388682567c 100644 --- a/packages/router/src/events.ts +++ b/packages/router/src/events.ts @@ -134,7 +134,7 @@ export class NavigationEnd extends RouterEvent { /** * 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`. * * @see `NavigationStart`