This component is responsible for page transitioning and managing the pages of your OnsenUI application. In order to manage to display the pages, the navigator needs to define the renderPage method, that takes an route and a navigator and converts it to an page.
The Navigator is a component that provides stack based navigation. It is a very common navigation pattern in mobile apps.
After pushing a page to the top of the stack it will be displayed using transition animation. When the user goes back to the previous page the top page will be popped from the top of the stack and hidden with an corresponding transition animation.
The Navigator maintains a stack of route objects. These objects can be arbitrary objects and are rendered into pages with the renderPage property. The renderPage property must be set to a function that returns a Page component.
To push a new page on top of the stack, the pushPage(route) method is used. Similarly, a page is popped from the stack with the popPage() method.
The stack must be initialized with either the initialRoute or initialRouteStack, depending on whether the the stack needs to be initialized with one or more pages.
The BackButton component can be used to put a back button in the navigation bar. The component will automatically find the Navigator component and pop a page when pressed.
<Toolbar>
<div className='left'>
<BackButton>Back</BackButton>
</div>
<div className='center'>
Title
</div>
</Toolbar>
There are several animations available for the Navigator component. To change the animation the animation property is used. Available animations are slide, lift and fade. Setting the property to none will make the transition instantly.
It is also possible to customize the duration, delay and timing function of the animation using the animationOptions property.
<Navigator
initialRoute={...}
renderPage={...}
animation='fade'
animationOptions={{duration: 0.2, timing: 'ease-in'}}
/>
For iOS’ “swipe to pop” feature, add the swipeable prop. Note that this behavior is automatically removed on Android platforms unless swipeable={'force'} is specified.
| Name | Type Default Value | Description |
|---|---|---|
| renderPage | function | This function takes the current route object as a parameter and returns a React component. Required. |
| initialRouteStack | array |
This array contains the initial routes from the Navigator,
which will be used to render the initial pages in the |
| initialRoute | object |
This array contains the initial route of the navigator, which will be used to render the initial pages in the renderPage method. Optional. |
| onPrePush |
function
() => null |
Called just before a page is pushed. It gets an event object with route information. Optional. |
| onPostPush |
function
() => null |
Called just after a page is pushed. It gets an event object with route information. Optional. |
| onPrePop |
function
() => null |
Called just before a page is popped. It gets an event object with route information. Optional. |
| onPostPop |
function
() => null |
Called just after a page is popped. It gets an event object with route information. Optional. |
| animation | String |
Animation name. Available animations are |
| animationOptions | object |
Specify the animation’s duration, delay and timing. E.g. {duration: 0.2, delay: 0.4, timing: 'ease-in'}.
Optional.
|
| swipeable | bool | Enables swipe-to-pop functionality for iOS. Optional. |
| swipePop | function | Optional function called on swipe-to-pop. If provided, must perform a popPage with the given options object. Optional. |
| onDeviceBackButton | function | Custom handler for device back button. Optional. |
| Signature | Description |
|---|---|
| resetPage(route, options = {}) | Resets the current page |
| resetPageStack(route, options = {}) | Resets the navigator to the current page stack |
| pushPage(route, options = {}) | Pushes a page to the page stack |
| popPage(options = {}) | Pops a page out of the page stack |
If you have any questions, use our Community Forum or talk to us via Gitter chat. The Onsen UI team and your peers in the community will work together to help solve your issues.
For bug reports and feature requests use our GitHub Issues page.