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

chore(popup): Adding API comments for docs for popups

Browse Source 
References #183
This commit is contained in:
Brandy Carney
2015-10-02 14:40:15 -04:00
parent 78224f35ea
commit 3b2eb8452e
1 changed files with 90 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
ionic/components/popup/popup.ts
View File

@ -10,9 +10,9 @@ import * as util from 'ionic/util';
/** /**
* @name Popup * @name Popup
* @description * @description
* The Ionic Popup service allows programmatically creating and showing popup windows that require the user to respond in order to continue. * The Ionic Popup service allows the creation of popup windows that require the user to respond in order to continue.
* *
* The popup system has support for more flexible versions of the built in `alert()`, `prompt()`, and `confirm()` functions that users are used to, in addition to allowing popups with completely custom content and look. * The popup service has support for more flexible versions of the built in `alert()`, `prompt()`, and `confirm()` functions that users are used to, in addition to allowing popups with completely custom content and look.
* *
* @usage * @usage
* ```ts * ```ts
@ -23,13 +23,23 @@ import * as util from 'ionic/util';
* } * }
* *
* doAlert() { * doAlert() {
* this.popup.alert('Alert').then(() => { * this.popup.alert({
* title: "New Friend!",
* template: "Your friend, Obi wan Kenobi, just accepted your friend request!",
* cssClass: 'my-alert'
* }).then(() => {
* console.log('Alert closed'); * console.log('Alert closed');
* }); * });
* } * }
* *
* doPrompt() { * doPrompt() {
* this.popup.prompt('What is your name?').then((name) => { * this.popup.prompt({
* title: "New Album",
* template: "Enter a name for this new album you're so keen on adding",
* inputPlaceholder: "Title",
* okText: "Save",
* okType: "secondary"
* }).then((name) => {
* console.log('Name entered:', name); * console.log('Name entered:', name);
* }, () => { * }, () => {
* console.error('Prompt closed'); * console.error('Prompt closed');
@ -37,7 +47,13 @@ import * as util from 'ionic/util';
* } * }
* *
* doConfirm() { * doConfirm() {
* this.popup.confirm('Are you sure?').then((result, ev) => { * this.popup.confirm({
* title: "Use this lightsaber?",
* subTitle: "You can't exchange lightsabers",
* template: "Do you agree to use this lightsaber to do good across the intergalactic galaxy?",
* cancelText: "Disagree",
* okText: "Agree"
* }).then((result, ev) => {
* console.log('Confirmed!', result); * console.log('Confirmed!', result);
* }, () => { * }, () => {
* console.error('Not confirmed!'); * console.error('Not confirmed!');
@ -49,12 +65,12 @@ import * as util from 'ionic/util';
@Injectable() @Injectable()
export class Popup extends Overlay { export class Popup extends Overlay {
/** /**
* TODO * TODO
* @param {TODO} opts TODO * @param {TODO} opts TODO
* @returns {TODO} TODO * @returns {object} A promise
*/ */
popup(opts) { popup(opts) {
return new Promise((resolve, reject)=> { return new Promise((resolve, reject)=> {
let config = this.config; let config = this.config;
let defaults = { let defaults = {
@ -70,9 +86,24 @@ export class Popup extends Overlay {
} }
/** /**
* TODO * Show a simple alert popup with a message and one button
* @param {TODO} opts TODO * that the user can tap to close the popup.
* @returns {TODO} TODO *
* @param {object} opts The options for showing the alert, of the form:
*
* ```
* {
* title: '', // String. The title of the popup.
* cssClass: '', // String (optional). The custom CSS class name.
* subTitle: '', // String (optional). The sub-title of the popup.
* template: '', // String (optional). The html template to place in the popup body.
* templateUrl: '', // String (optional). The URL of an html template to place in the popup body.
* okText: '', // String (default: 'OK'). The text of the OK button.
* okType: '', // String (default: 'primary'). The type of the OK button.
* }
* ```
*
* @returns {object} A promise which is resolved when the popup is closed.
*/ */
alert(opts={}) { alert(opts={}) {
if (typeof opts === 'string') { if (typeof opts === 'string') {
@ -101,9 +132,27 @@ export class Popup extends Overlay {
} }
/** /**
* TODO * Show a simple confirm popup with a message, Cancel and OK button.
* @param {TODO} opts TODO *
* @returns {TODO} TODO * Resolves the promise with true if the user presses the OK button, and false if the user presses the Cancel button.
*
* @param {object} opts The options for showing the confirm, of the form:
*
* ```
* {
* title: '', // String. The title of the popup.
* cssClass: '', // String (optional). The custom CSS class name.
* subTitle: '', // String (optional). The sub-title of the popup.
* template: '', // String (optional). The html template to place in the popup body.
* templateUrl: '', // String (optional). The URL of an html template to place in the popup body.
* cancelText: '', // String (default: 'Cancel'). The text of the Cancel button.
* cancelType: '', // String (default: 'primary'). The type of the Cancel button.
* okText: '', // String (default: 'OK'). The text of the OK button.
* okType: '', // String (default: 'primary'). The type of the OK button.
* }
* ```
*
* @returns {object} A promise which is resolved when the popup is closed.
*/ */
confirm(opts={}) { confirm(opts={}) {
if (typeof opts === 'string') { if (typeof opts === 'string') {
@ -137,9 +186,29 @@ export class Popup extends Overlay {
} }
/** /**
* TODO * Show a simple prompt popup with a message, input, Cancel and OK button.
* @param {TODO} [opts={}] TODO *
* @returns {TODO} TODO * Resolves the promise with the value of the input if the user presses OK, and with undefined if the user presses Cancel.
*
* @param {object} opts The options for showing the prompt, of the form:
*
* ```
* {
* title: '', // String. The title of the popup.
* cssClass: '', // String (optional). The custom CSS class name.
* subTitle: '', // String (optional). The sub-title of the popup.
* template: '', // String (optional). The html template to place in the popup body.
* templateUrl: '', // String (optional). The URL of an html template to place in the popup body.
* inputType: // String (default: 'text'). The type of input to use.
* inputPlaceholder: // String (default: ''). A placeholder to use for the input.
* cancelText: '', // String (default: 'Cancel'). The text of the Cancel button.
* cancelType: '', // String (default: 'primary'). The type of the Cancel button.
* okText: '', // String (default: 'OK'). The text of the OK button.
* okType: '', // String (default: 'primary'). The type of the OK button.
* }
* ```
*
* @returns {object} A promise which is resolved when the popup is closed.
*/ */
prompt(opts={}) { prompt(opts={}) {
if (typeof opts === 'string') { if (typeof opts === 'string') {
@ -179,7 +248,7 @@ export class Popup extends Overlay {
/** /**
* TODO * TODO
* @param {TODO} opts TODO * @param {TODO} handle TODO
* @returns {TODO} TODO * @returns {TODO} TODO
*/ */
get(handle) { get(handle) {