From eb3235f874526ea67f4dc05bea3d018d7b2128fd Mon Sep 17 00:00:00 2001 From: mhartington Date: Thu, 18 Feb 2016 19:13:55 -0500 Subject: [PATCH] docs(actionsheet): add docs for actionsheet options --- ionic/components/action-sheet/action-sheet.ts | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/ionic/components/action-sheet/action-sheet.ts b/ionic/components/action-sheet/action-sheet.ts index ede74cfb9f..87f4e7031f 100644 --- a/ionic/components/action-sheet/action-sheet.ts +++ b/ionic/components/action-sheet/action-sheet.ts @@ -124,6 +124,28 @@ import {ViewController} from '../nav/view-controller'; } /** + * Open an action sheet with the following options + * + * | Option | Type | Description | + * |-----------------------|------------|-----------------------------------------------------------------| + * | title |`string` | The title for the actionsheet | + * | subTitle |`string` | The sub-title for the actionsheet | + * | cssClass |`string` | An additional class for custom styles | + * | enableBackdropDismiss |`boolean` | If the actionsheet should close when the user taps the backdrop | + * | buttons |`array`| An array of buttons to display | + * + * For the buttons: + * + * | Option | Type | Description | + * |----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------| + * | text | `string` | The buttons text | + * | icon | `icon` | The buttons icons | + * | handler | `any` | An express the button shoule evaluate | + * | cssClass | `string` | An additional class for custom styles | + * | role | `string` | How the button should be displayed, `destructive` or `cancel`. If not role is provided, it will display the button without any additional styles | + * + * + * * @param {object} opts Action sheet options */ static create(opts: {