ion-router-outlet
Router outlet is a component used in routing within an Angular app. It behaves in a similar way to Angular's built-in router outlet component, but contains the logic for providing a stacked navigation, and animating views in and out.
Note: this component should only be used with Angular projects. For vanilla or Stencil JavaScript projects, use
and ion-router
. ion-route
Although router outlet has methods for navigating around, it's recommended to use the navigation methods in Angular's router.
Life Cycle Hooks
Routes rendered in a Router Outlet have access to specific Ionic events that are wired up to animations
Event Name | Trigger |
---|---|
ionViewWillEnter |
Fired when the component being routed to is about to animate in. |
ionViewDidEnter |
Fired when the component being routed to has animated in. |
ionViewWillLeave |
Fired when the component being routed from is about to animate. |
ionViewDidLeave |
Fired when the component being routed from has animated. |
These event tie into Ionic's animation system and can be used to coordinate parts of your app when a Components is done with it's animation. These events are not a replacement for Angular's own event system, but an addition.
For handling Router Guards, the older ionViewCanEnter
and
ionViewCanLeave
have been replaced with their framework specific equivalent. For Angular, there are
Router Guards.
Properties
animated | |
---|---|
Description | If
|
Attribute | animated |
Type | boolean |
Default | true |
animation | |
Description | By default |
Type | ((Animation: Animation, baseEl: any, opts?: any) => Promise<Animation>) | undefined |
mode | |
Description | The mode determines which platform styles to use. |
Attribute | mode |
Type | "ios" | "md" |
Default | getIonMode(this) |