docs(plugins): update docs and plugin params

This commit is contained in:
Ibrahim Hadeed
2016-03-12 18:30:16 -05:00
parent 4d8dc1b9dc
commit a1bdff6b24
25 changed files with 149 additions and 35 deletions
+15
View File
@@ -8,9 +8,24 @@ export interface ToastOptions {
addPixelsY?: number;
}
/**
* @name Toast
* @description
* This plugin allows you to show a native Toast (a little text popup) on iOS, Android and WP8. It's great for showing a non intrusive native notification which is guaranteed always in the viewport of the browser.
*
* Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin).
*
* ```shell
* cordova plugin add cordova-plugin-x-toast
* ```
*
* @usage
* ```ts
* Toast.show("I'm a toast", 5000, "center").subscribe(
* toast => {
* console.log(toast);
* }
* );
* ```
*/
@Plugin({
plugin: 'cordova-plugin-x-toast',