javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(ionic-angular): update docs from master

Browse Source
This commit is contained in:
Brandy Carney
2017-08-31 14:22:45 -04:00
parent 00c883194c
commit 374bdd3668
7 changed files with 32 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
packages/ionic-angular/src/navigation/nav-params.ts
View File

@@ -6,14 +6,18 @@
* option with a simple `get` method.
*
* @usage
*
* ```ts
* export class MyClass{
* constructor(public navParams: NavParams){
* // userParams is an object we have in our nav-parameters
* this.navParams.get('userParams');
* }
* import { NavParams } from 'ionic-angular';
*
* export class MyClass {
* constructor(public navParams: NavParams) {
* // userParams is an object we have in our nav-parameters
* this.navParams.get('userParams');
* }
* }
* ```
*
* @demo /docs/demos/src/nav-params/
* @see {@link /docs/components#navigation Navigation Component Docs}
* @see {@link ../NavController/ NavController API Docs}
@@ -29,19 +33,21 @@ export class NavParams {
constructor(public data: any = {}) {}
/**
* Get the value of a nav-parameter for the current view
* Get the value of a navigation parameter for the current view
*
* ```ts
* export class MyClass{
* constructor(public navParams: NavParams){
* // userParams is an object we have in our nav-parameters
* this.navParams.get('userParams');
* }
* import { NavParams } from 'ionic-angular';
*
* export class MyClass {
* constructor(public navParams: NavParams) {
* // userParams is an object we have in our navigation parameters
* this.navParams.get('userParams');
* }
* }
* ```
*
*
* @param {string} param Which param you want to look up
* @param {string} param the parameter you want to get the value for
*/
get(param: string): any {
return this.data[param];