From 54a33e08e7c537874395c00ef418845e865b8cde Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Wed, 10 Aug 2016 11:11:59 -0400 Subject: [PATCH] docs(overlays): update the overlay docs for multiple classes in cssClass closes #7618 --- src/components/action-sheet/action-sheet.ts | 25 ++++++------- src/components/alert/alert.ts | 41 +++++++++++---------- src/components/loading/loading.ts | 2 +- src/components/popover/popover.ts | 2 +- src/components/toast/toast.ts | 2 +- 5 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/components/action-sheet/action-sheet.ts b/src/components/action-sheet/action-sheet.ts index d0986e50b0..ed032d5517 100644 --- a/src/components/action-sheet/action-sheet.ts +++ b/src/components/action-sheet/action-sheet.ts @@ -150,24 +150,23 @@ export class ActionSheet extends ViewController { * * ActionSheet create 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 | + * | Option | Type | Description | + * |-----------------------|------------|--------------------------------------------------------------------| + * | title |`string` | The title for the Action Sheet. | + * | subTitle |`string` | The sub-title for the Action Sheet. | + * | cssClass |`string` | Additional classes for custom styles, separated by spaces. | + * | enableBackdropDismiss |`boolean` | If the Action Sheet should close when the user taps the backdrop. | + * | buttons |`array`| An array of buttons to display. | * * ActionSheet button options * * | Option | Type | Description | * |----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------| - * | text | `string` | The buttons text | - * | icon | `icon` | The buttons icons | - * | handler | `any` | An express the button should 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 | - * + * | text | `string` | The buttons text. | + * | icon | `icon` | The buttons icons. | + * | handler | `any` | An express the button should evaluate. | + * | cssClass | `string` | Additional classes for custom styles, separated by spaces. | + * | 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.| * * * ### Dismissing And Async Navigation diff --git a/src/components/alert/alert.ts b/src/components/alert/alert.ts index be30bba1a6..3a511a5aa5 100644 --- a/src/components/alert/alert.ts +++ b/src/components/alert/alert.ts @@ -235,35 +235,36 @@ export class Alert extends ViewController { * * | Property | Type | Description | * |-----------------------|-----------|---------------------------------------------------------------------------| - * | title | `string` | The string for the alert (optional) | - * | subTitle | `string` | The subtitle for the alert (optional) | - * | message | `string` | The message for the alert (optional) | - * | cssClass | `string` | Any additional class for the alert (optional) | - * | inputs | `array` | An array of inputs for the alert. See input options. (optional) | - * | buttons | `array` | An array of buttons for the alert. See buttons options. (optional) | - * | enableBackdropDismiss | `boolean` | Whether the alert should be dismissed by tapping the backdrop (optional) | + * | title | `string` | The title for the alert. | + * | subTitle | `string` | The subtitle for the alert. | + * | message | `string` | The message for the alert. | + * | cssClass | `string` | Additional classes for custom styles, separated by spaces. | + * | inputs | `array` | An array of inputs for the alert. See input options. | + * | buttons | `array` | An array of buttons for the alert. See buttons options. | + * | enableBackdropDismiss | `boolean` | Whether the alert should be dismissed by tapping the backdrop. | * * * Input options * * | Property | Type | Description | * |-------------|-----------|-----------------------------------------------------------------| - * | type | `string` | The type the input should be, text, tel, number, etc (optional) | - * | name | `string` | The name for the input (optional) | - * | placeholder | `string` | The input's placeholder (optional, for textual/numeric inputs) | - * | value | `string` | The input's value (optional) | - * | label | `string` | The input's label (optional, only for radio/checkbox inputs) | - * | checked | `boolean` | Whether or not the input is checked or not (optional) | - * | id | `string` | The input's id (optional) | + * | type | `string` | The type the input should be: text, tel, number, etc. | + * | name | `string` | The name for the input. | + * | placeholder | `string` | The input's placeholder (for textual/numeric inputs) | + * | value | `string` | The input's value. | + * | label | `string` | The input's label (only for radio/checkbox inputs) | + * | checked | `boolean` | Whether or not the input is checked. | + * | id | `string` | The input's id. | * * Button options * - * | Property | Type | Description | - * |----------|----------|----------------------------------------------------------------| - * | text | `string` | The buttons displayed text | - * | handler | `any` | Expression that should be evaluated when the button is pressed | - * | cssClass | `string` | An additional CSS class for the button | - * | role | `string` | The buttons role, null or `cancel` | + * | Property | Type | Description | + * |----------|----------|-----------------------------------------------------------------| + * | text | `string` | The buttons displayed text. | + * | handler | `any` | Expression that should be evaluated when the button is pressed. | + * | cssClass | `string` | An additional CSS class for the button. | + * | role | `string` | The buttons role, null or `cancel`. | + * * ### Dismissing And Async Navigation * * After an alert has been dismissed, the app may need to also transition diff --git a/src/components/loading/loading.ts b/src/components/loading/loading.ts index b1ab2912f1..4b495de962 100644 --- a/src/components/loading/loading.ts +++ b/src/components/loading/loading.ts @@ -158,7 +158,7 @@ export class Loading extends ViewController { * |-----------------------|------------|------------------------------------------------------------------------------------------------------------------| * | spinner |`string` | The name of the SVG spinner for the loading indicator. | * | content |`string` | The html content for the loading indicator. | - * | cssClass |`string` | An additional class for custom styles. | + * | cssClass |`string` | Additional classes for custom styles, separated by spaces. | * | showBackdrop |`boolean` | Whether to show the backdrop. Default true. | * | dismissOnPageChange |`boolean` | Whether to dismiss the indicator when navigating to a new page. Default false. | * | duration |`number` | How many milliseconds to wait before hiding the indicator. By default, it will show until `dismiss()` is called. | diff --git a/src/components/popover/popover.ts b/src/components/popover/popover.ts index a8683f3319..4b7754dc3b 100644 --- a/src/components/popover/popover.ts +++ b/src/components/popover/popover.ts @@ -151,7 +151,7 @@ export class Popover extends ViewController { * * | Option | Type | Description | * |-----------------------|------------|------------------------------------------------------------------------------------------------------------------| - * | cssClass |`string` | An additional class for custom styles. | + * | cssClass |`string` | Additional classes for custom styles, separated by spaces. | * | showBackdrop |`boolean` | Whether to show the backdrop. Default true. | * | enableBackdropDismiss |`boolean` | Whether the popover should be dismissed by tapping the backdrop. Default true. | * diff --git a/src/components/toast/toast.ts b/src/components/toast/toast.ts index 0b7ee2dcd5..89e7001ea3 100644 --- a/src/components/toast/toast.ts +++ b/src/components/toast/toast.ts @@ -132,7 +132,7 @@ export class Toast extends ViewController { * | message | `string` | - | The message for the toast. Long strings will wrap and the toast container will expand. | * | duration | `number` | - | How many milliseconds to wait before hiding the toast. By default, it will show until `dismiss()` is called. | * | position | `string` | "bottom" | The position of the toast on the screen. Accepted values: "top", "middle", "bottom". | - * | cssClass | `string` | - | Any additional class for custom styles. | + * | cssClass | `string` | - | Additional classes for custom styles, separated by spaces. | * | showCloseButton | `boolean` | false | Whether or not to show a button to close the toast. | * | closeButtonText | `string` | "Close" | Text to display in the close button. | * | dismissOnPageChange | `boolean` | false | Whether to dismiss the toast when navigating to a new page. |