github/awesome-cordova-plugins
github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-04-21 17:36:27 +08:00
Code Issues Projects Releases Wiki Activity

docs(action-sheet): fix wrong jsdocs

Browse Source
This commit is contained in:
Daniel 2018-04-08 18:22:48 +02:00
parent f7b5e2f15f
commit 31c696d59d
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/@ionic-native/plugins/action-sheet/index.ts
View File

@ -1,8 +1,7 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
export interface ActionSheetOptions { export interface ActionSheetOptions {
/** /**
* The labels for the buttons. Uses the index x * The labels for the buttons. Uses the index x
*/ */
@ -98,7 +97,6 @@ export interface ActionSheetOptions {
}) })
@Injectable() @Injectable()
export class ActionSheet extends IonicNativePlugin { export class ActionSheet extends IonicNativePlugin {
/** /**
* Convenience property to select an Android theme value * Convenience property to select an Android theme value
*/ */
@ -118,18 +116,22 @@ export class ActionSheet extends IonicNativePlugin {
/** /**
* Show a native ActionSheet component. See below for options. * Show a native ActionSheet component. See below for options.
* @param options {ActionSheetOptions} Options See table below * @param {ActionSheetOptions} [options] Options See table below
* @returns {Promise<any>} Returns a Promise that resolves with the index of the * @returns {Promise<any>} Returns a Promise that resolves with the index of the
* button pressed (1 based, so 1, 2, 3, etc.) * button pressed (1 based, so 1, 2, 3, etc.)
*/ */
@Cordova() @Cordova()
show(options?: ActionSheetOptions): Promise<number> { return; } show(options?: ActionSheetOptions): Promise<number> {
return;
}
/** /**
* Progamtically hide the native ActionSheet * Programmatically hide the native ActionSheet
* @param {any} options?
* @returns {Promise<any>} Returns a Promise that resolves when the actionsheet is closed * @returns {Promise<any>} Returns a Promise that resolves when the actionsheet is closed
*/ */
@Cordova() @Cordova()
hide(options?: any): Promise<any> { return; } hide(options?: any): Promise<any> {
return;
}
} }