javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 11:17:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(): modal

Browse Source
This commit is contained in:
mhartington
2015-12-16 19:56:09 -05:00
parent cc97919bcc
commit 82d3f4745d
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
ionic/components/modal/modal.ts
View File

@ -6,10 +6,13 @@ import {Animation} from '../../animations/animation';
import {extend} from '../../util'; import {extend} from '../../util';
/** /**
* @name Modal
* @description
* The Modal is a content pane that can go over the user's current page. * The Modal is a content pane that can go over the user's current page.
* Usually used for making a choice or editing an item. A modal can be opened * Usually used for making a choice or editing an item. A modal can be opened
* similar to how NavController#push works, where it is passed a Page component, * similar to how {@link /docs/v2/api/components/nav/NavController/#push NavController.push} works,
* along with optional Page params, and options for presenting the modal. * where it is passed a Page component, along with optional Page params,
* and options for presenting the modal.
* *
* @usage * @usage
* ```ts * ```ts
@ -47,9 +50,10 @@ export class Modal {
/** /**
* Opens a new modal using the page component is was pass as the first * Opens a new modal using the page component is was pass as the first
* argument. This is similar to how NavController's `push` method works. * argument. This is similar to how NavController's `push` method works.
* Currently you must have `<ion-overlay>` in the @App component's template * Currently you must have `<ion-overlay>` in the `@App` component's template
* for the modal to work correctly. (This is something that will * for the modal to work correctly. (This is something that will
* be hopefully be removed in the near future.) * be hopefully be removed in the near future.)
*
* @param pageComponent The Page component to load in the modal. * @param pageComponent The Page component to load in the modal.
* @param {Object} [params={}] Optional data which can be passed to the page * @param {Object} [params={}] Optional data which can be passed to the page
* component, which can be read from the constructor's `NavParams`. * component, which can be read from the constructor's `NavParams`.