| 1 | /**
|
| 2 | * @name NavParams
|
| 3 | * @description
|
| 4 | * NavParams are an object that exists on a page and can contain data for that particular view.
|
| 5 | * Similar to how data was pass to a view in V1 with `$stateParams`, NavParams offer a much more flexible
|
| 6 | * option with a simple `get` method.
|
| 7 | *
|
| 8 | * @usage
|
| 9 | * ```ts
|
| 10 | * import { NavParams } from 'ionic-angular';
|
| 11 | *
|
| 12 | * export class MyClass{
|
| 13 | *
|
| 14 | * constructor(navParams: NavParams){
|
| 15 | * // userParams is an object we have in our nav-parameters
|
| 16 | * navParams.get('userParams');
|
| 17 | * }
|
| 18 | *
|
| 19 | * }
|
| 20 | * ```
|
| 21 | * @demo /docs/demos/src/nav-params/
|
| 22 | * @see {@link /docs/components#navigation Navigation Component Docs}
|
| 23 | * @see {@link ../NavController/ NavController API Docs}
|
| 24 | * @see {@link /docs/api/components/nav/Nav/ Nav API Docs}
|
| 25 | * @see {@link /docs/api/components/nav/NavPush/ NavPush API Docs}
|
| 26 | */
|
| 27 | export declare class NavParams {
|
| 28 | data: any;
|
| 29 | /**
|
| 30 | * @hidden
|
| 31 | * @param {TODO} data TODO
|
| 32 | */
|
| 33 | constructor(data?: any);
|
| 34 | /**
|
| 35 | * Get the value of a nav-parameter for the current view
|
| 36 | *
|
| 37 | * ```ts
|
| 38 | * import { NavParams } from 'ionic-angular';
|
| 39 | *
|
| 40 | * export class MyClass{
|
| 41 | * constructor(public navParams: NavParams){
|
| 42 | * // userParams is an object we have in our nav-parameters
|
| 43 | * this.navParams.get('userParams');
|
| 44 | * }
|
| 45 | * }
|
| 46 | * ```
|
| 47 | *
|
| 48 | *
|
| 49 | * @param {string} param Which param you want to look up
|
| 50 | */
|
| 51 | get(param: string): any;
|
| 52 | }
|
| 53 | |
| \ | No newline at end of file |