123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359 |
- (function (factory) {
- if (typeof module === "object" && typeof module.exports === "object") {
- var v = factory(require, exports);
- if (v !== undefined) module.exports = v;
- }
- else if (typeof define === "function" && define.amd) {
- define(["require", "exports"], factory);
- }
- })(function (require, exports) {
- "use strict";
- Object.defineProperty(exports, "__esModule", { value: true });
- /**
- * @name NavController
- * @description
- *
- * NavController is the base class for navigation controller components like
- * [`Nav`](../../components/nav/Nav/) and [`Tab`](../../components/tabs/Tab/). You use navigation controllers
- * to navigate to [pages](#view-creation) in your app. At a basic level, a
- * navigation controller is an array of pages representing a particular history
- * (of a Tab for example). This array can be manipulated to navigate throughout
- * an app by pushing and popping pages or inserting and removing them at
- * arbitrary locations in history.
- *
- * The current page is the last one in the array, or the top of the stack if we
- * think of it that way. [Pushing](#push) a new page onto the top of the
- * navigation stack causes the new page to be animated in, while [popping](#pop)
- * the current page will navigate to the previous page in the stack.
- *
- * Unless you are using a directive like [NavPush](../../components/nav/NavPush/), or need a
- * specific NavController, most times you will inject and use a reference to the
- * nearest NavController to manipulate the navigation stack.
- *
- * ## Basic usage
- * The simplest way to navigate through an app is to create and initialize a new
- * nav controller using the `<ion-nav>` component. `ion-nav` extends the `NavController`
- * class.
- *
- * ```typescript
- * import { Component } from `@angular/core`;
- * import { StartPage } from './start-page';
- *
- * @Component(
- * template: `<ion-nav [root]="rootPage"></ion-nav>`
- * })
- * class MyApp {
- * // set the rootPage to the first page we want displayed
- * public rootPage: any = StartPage;
- *
- * constructor(){
- * }
- * }
- *
- * ```
- *
- * ### Injecting NavController
- * Injecting NavController will always get you an instance of the nearest
- * NavController, regardless of whether it is a Tab or a Nav.
- *
- * Behind the scenes, when Ionic instantiates a new NavController, it creates an
- * injector with NavController bound to that instance (usually either a Nav or
- * Tab) and adds the injector to its own providers. For more information on
- * providers and dependency injection, see [Dependency Injection](https://angular.io/docs/ts/latest/guide/dependency-injection.html).
- *
- * Instead, you can inject NavController and know that it is the correct
- * navigation controller for most situations (for more advanced situations, see
- * [Menu](../../menu/Menu/) and [Tab](../../tab/Tab/)).
- *
- * ```ts
- * import { NavController } from 'ionic-angular';
- *
- * class MyComponent {
- * constructor(public navCtrl: NavController) {
- *
- * }
- * }
- * ```
- *
- * ### Navigating from the Root component
- * What if you want to control navigation from your root app component?
- * You can't inject `NavController` because any components that are navigation
- * controllers are _children_ of the root component so they aren't available
- * to be injected.
- *
- * By adding a reference variable to the `ion-nav`, you can use `@ViewChild` to
- * get an instance of the `Nav` component, which is a navigation controller
- * (it extends `NavController`):
- *
- * ```typescript
- *
- * import { Component, ViewChild } from '@angular/core';
- * import { NavController } from 'ionic-angular';
- *
- * @Component({
- * template: '<ion-nav #myNav [root]="rootPage"></ion-nav>'
- * })
- * export class MyApp {
- * @ViewChild('myNav') nav: NavController
- * public rootPage: any = TabsPage;
- *
- * // Wait for the components in MyApp's template to be initialized
- * // In this case, we are waiting for the Nav with reference variable of "#myNav"
- * ngOnInit() {
- * // Let's navigate from TabsPage to Page1
- * this.nav.push(Page1);
- * }
- * }
- * ```
- *
- * ### Navigating from an Overlay Component
- * What if you wanted to navigate from an overlay component (popover, modal, alert, etc)?
- * In this example, we've displayed a popover in our app. From the popover, we'll get a
- * reference of the root `NavController` in our app, using the `getRootNav()` method.
- *
- *
- * ```typescript
- * import { Component } from '@angular/core';
- * import { App, ViewController } from 'ionic-angular';
- *
- * @Component({
- * template: `
- * <ion-content>
- * <h1>My PopoverPage</h1>
- * <button ion-button (click)="pushPage()">Call pushPage</button>
- * </ion-content>
- * `
- * })
- * class PopoverPage {
- * constructor(
- * public viewCtrl: ViewController
- * public appCtrl: App
- * ) {}
- *
- * pushPage() {
- * this.viewCtrl.dismiss();
- * this.appCtrl.getRootNav().push(SecondPage);
- * }
- * }
- *```
- *
- *
- * ## View creation
- * Views are created when they are added to the navigation stack. For methods
- * like [push()](#push), the NavController takes any component class that is
- * decorated with `@Component` as its first argument. The NavController then
- * compiles that component, adds it to the app and animates it into view.
- *
- * By default, pages are cached and left in the DOM if they are navigated away
- * from but still in the navigation stack (the exiting page on a `push()` for
- * example). They are destroyed when removed from the navigation stack (on
- * [pop()](#pop) or [setRoot()](#setRoot)).
- *
- * ## Pushing a View
- * To push a new view onto the navigation stack, use the `push` method.
- * If the page has an [`<ion-navbar>`](../../navbar/Navbar/),
- * a back button will automatically be added to the pushed view.
- *
- * Data can also be passed to a view by passing an object to the `push` method.
- * The pushed view can then receive the data by accessing it via the `NavParams`
- * class.
- *
- * ```typescript
- * import { Component } from '@angular/core';
- * import { NavController } from 'ionic-angular';
- * import { OtherPage } from './other-page';
- * @Component({
- * template: `
- * <ion-header>
- * <ion-navbar>
- * <ion-title>Login</ion-title>
- * </ion-navbar>
- * </ion-header>
- *
- * <ion-content>
- * <button ion-button (click)="pushPage()">
- * Go to OtherPage
- * </button>
- * </ion-content>
- * `
- * })
- * export class StartPage {
- * constructor(public navCtrl: NavController) {
- * }
- *
- * pushPage(){
- * // push another page onto the navigation stack
- * // causing the nav controller to transition to the new page
- * // optional data can also be passed to the pushed page.
- * this.navCtrl.push(OtherPage, {
- * id: "123",
- * name: "Carl"
- * });
- * }
- * }
- *
- * import { NavParams } from 'ionic-angular';
- *
- * @Component({
- * template: `
- * <ion-header>
- * <ion-navbar>
- * <ion-title>Other Page</ion-title>
- * </ion-navbar>
- * </ion-header>
- * <ion-content>I'm the other page!</ion-content>`
- * })
- * class OtherPage {
- * constructor(private navParams: NavParams) {
- * let id = navParams.get('id');
- * let name = navParams.get('name');
- * }
- * }
- * ```
- *
- * ## Removing a view
- * To remove a view from the stack, use the `pop` method.
- * Popping a view will transition to the previous view.
- *
- * ```ts
- * import { Component } from '@angular/core';
- * import { NavController } from 'ionic-angular';
- *
- * @Component({
- * template: `
- * <ion-header>
- * <ion-navbar>
- * <ion-title>Other Page</ion-title>
- * </ion-navbar>
- * </ion-header>
- * <ion-content>I'm the other page!</ion-content>`
- * })
- * class OtherPage {
- * constructor(public navCtrl: NavController ){
- * }
- *
- * popView(){
- * this.navCtrl.pop();
- * }
- * }
- * ```
- *
- * ## Lifecycle events
- * Lifecycle events are fired during various stages of navigation. They can be
- * defined in any component type which is pushed/popped from a `NavController`.
- *
- * ```ts
- * import { Component } from '@angular/core';
- *
- * @Component({
- * template: 'Hello World'
- * })
- * class HelloWorld {
- * ionViewDidLoad() {
- * console.log("I'm alive!");
- * }
- * ionViewWillLeave() {
- * console.log("Looks like I'm about to leave :(");
- * }
- * }
- * ```
- *
- * | Page Event | Returns | Description |
- * |---------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- * | `ionViewDidLoad` | void | Runs when the page has loaded. This event only happens once per page being created. If a page leaves but is cached, then this event will not fire again on a subsequent viewing. The `ionViewDidLoad` event is good place to put your setup code for the page. |
- * | `ionViewWillEnter` | void | Runs when the page is about to enter and become the active page. |
- * | `ionViewDidEnter` | void | Runs when the page has fully entered and is now the active page. This event will fire, whether it was the first load or a cached page. |
- * | `ionViewWillLeave` | void | Runs when the page is about to leave and no longer be the active page. |
- * | `ionViewDidLeave` | void | Runs when the page has finished leaving and is no longer the active page. |
- * | `ionViewWillUnload` | void | Runs when the page is about to be destroyed and have its elements removed. |
- * | `ionViewCanEnter` | boolean/Promise<void> | Runs before the view can enter. This can be used as a sort of "guard" in authenticated views where you need to check permissions before the view can enter |
- * | `ionViewCanLeave` | boolean/Promise<void> | Runs before the view can leave. This can be used as a sort of "guard" in authenticated views where you need to check permissions before the view can leave |
- *
- *
- * ## Nav Guards
- *
- * In some cases, a developer should be able to control views leaving and entering. To allow for this, NavController has the `ionViewCanEnter` and `ionViewCanLeave` methods.
- * Similar to Angular route guards, but are more integrated with NavController. For example, if you wanted to prevent a user from leaving a view:
- *
- * ```ts
- * export class MyClass{
- * constructor(
- * public navCtrl: NavController
- * ){}
- *
- * pushPage(){
- * this.navCtrl.push(DetailPage);
- * }
- *
- * ionViewCanLeave(): boolean{
- * // here we can either return true or false
- * // depending on if we want to leave this view
- * if(isValid(randomValue)){
- * return true;
- * } else {
- * return false;
- * }
- * }
- * }
- * ```
- *
- * We need to make sure that our `navCtrl.push` has a catch in order to catch the and handle the error.
- * If you need to prevent a view from entering, you can do the same thing
- *
- * ```ts
- * export class MyClass{
- * constructor(
- * public navCtrl: NavController
- * ){}
- *
- * pushPage(){
- * this.navCtrl.push(DetailPage);
- * }
- *
- * }
- *
- * export class DetailPage(){
- * constructor(
- * public navCtrl: NavController
- * ){}
- * ionViewCanEnter(): boolean{
- * // here we can either return true or false
- * // depending on if we want to enter this view
- * if(isValid(randomValue)){
- * return true;
- * } else {
- * return false;
- * }
- * }
- * }
- * ```
- *
- * Similar to `ionViewCanLeave` we still need a catch on the original `navCtrl.push` in order to handle it properly.
- * When handling the back button in the `ion-navbar`, the catch is already taken care of for you by the framework.
- *
- * ## NavOptions
- *
- * Some methods on `NavController` allow for customizing the current transition.
- * To do this, we can pass an object with the modified properites.
- *
- *
- * | Property | Value | Description |
- * |-----------|-----------|------------------------------------------------------------------------------------------------------------|
- * | animate | `boolean` | Whether or not the transition should animate. |
- * | animation | `string` | What kind of animation should be used. |
- * | direction | `string` | The conceptual direction the user is navigating. For example, is the user navigating `forward`, or `back`? |
- * | duration | `number` | The length in milliseconds the animation should take. |
- * | easing | `string` | The easing for the animation. |
- *
- * The property 'animation' understands the following values: `md-transition`, `ios-transition` and `wp-transition`.
- *
- * @see {@link /docs/components#navigation Navigation Component Docs}
- */
- var NavController = (function () {
- function NavController() {
- }
- return NavController;
- }());
- exports.NavController = NavController;
- });
- //# sourceMappingURL=nav-controller.js.map
|