docs: add detail to router event doc

angular · Aug 19, 2019 · 4a9518d · 4a9518d
1 parent 5f76de1
commit 4a9518d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/aio/content/guide/router.md b/aio/content/guide/router.md
@@ -519,7 +519,8 @@ During each navigation, the `Router` emits navigation events through the `Router
     <td>
 
       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>
   </tr>

diff --git a/packages/router/src/events.ts b/packages/router/src/events.ts
@@ -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
  */