ionic-framework
Version:
The ionic-framework package comes with both Javascript and Sass frontend dependencies, located in the root of the package, and a Node API, located in `tooling/`.
55 lines (54 loc) • 1.52 kB
JavaScript
/**
* @name NavParams
* @description
* NavParams are an object that exists on a page and can contain data for that particular view.
* Similar to how data was pass to a view in V1 with `$stateParams`, NavParams offer a much more flexible
* option with a simple `get` method.
*
* @usage
* ```ts
* export class MyClass{
* constructor(params: NavParams){
* this.params = params;
* // userParams is an object we have in our nav-parameters
* this.params.get('userParams');
* }
* }
* ```
* @demo /docs/v2/demos/nav-params/
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
* @see {@link ../NavController/ NavController API Docs}
* @see {@link ../Nav/ Nav API Docs}
* @see {@link ../NavPush/ NavPush API Docs}
*/
var NavParams = (function () {
/**
* @private
* @param {TODO} data TODO
*/
function NavParams(data) {
if (data === void 0) { data = {}; }
this.data = data;
}
/**
* Get the value of a nav-parameter for the current view
*
* ```ts
* export class MyClass{
* constructor(params: NavParams){
* this.params = params;
* // userParams is an object we have in our nav-parameters
* this.params.get('userParams');
* }
* }
* ```
*
*
* @param {string} parameter Which param you want to look up
*/
NavParams.prototype.get = function (param) {
return this.data[param];
};
return NavParams;
})();
exports.NavParams = NavParams;