awesome-cordova-plugins/src/plugins/spinnerdialog.ts
Guillermo 7952f9ef60 Improvements on documentation (#340)
* Improvements on documentation and some refactor

* ts | js -> typescript (docs)
2016-07-20 11:17:09 -04:00

53 lines
1.2 KiB
TypeScript

import { Cordova, Plugin } from './plugin';
/**
* @name Spinner Dialog
* @description
* @usage
* ```typescript
* 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;
}