awesome-cordova-plugins/src/plugins/spinnerdialog.ts
Nick Kenens 0315e63782 Update spinnerdialog.ts to fix wrong documentation (#287)
Just implemented the SpinnerDialog into my app to use with Ionic Deploy.

The cancelCallback still happens when set to "false", when setting it to "true, the cancelCallback doesn't get called and therefore the SpinnerDialog doesn't hide on Android.
2016-07-13 17:36:23 -04:00

54 lines
1.2 KiB
TypeScript

import {Plugin, Cordova} from './plugin';
/**
* @name Spinner Dialog
* @description
* @usage
* ```js
* import {SpinnerDialog} from 'ionic-native';
*
*
*
* SpinnerDialog.show();
*
* SpinnerDialog.hide();
* ```
*/
@Plugin({
plugin: 'cordova-plugin-spinner-dialog',
pluginRef: 'window.plugins.spinnerDialog',
repo: 'https://github.com/Paldom/SpinnerDialog',
platforms: ['Android', 'iOS', 'Windows Phone 8']
})
export class SpinnerDialog {
/**
* Shows the spinner dialog
* @param title {string} Spinner title (shows on Android only)
* @param message {string} Spinner message
* @param cancelCallback {boolean|function} Set to true to set spinner not cancelable. Or provide a function to call when the user cancels the spinner.
* @param iOSOptions {object} Options for iOS only
*/
@Cordova({
sync: true
})
static show(title?: string, message?: string, cancelCallback?: any, iOSOptions?: SpinnerDialogIOSOptions): void {}
/**
* Hides the spinner dialog if visible
*/
@Cordova({
sync: true
})
static hide(): void {}
}
export interface SpinnerDialogIOSOptions {
overlayOpacity?: number;
textColorRed?: number;
textColorGreen?: number;
textColorBlue?: number;
}