javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 13:32:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(overlays): update the overlay docs for multiple classes in cssClass

Browse Source 
closes #7618
This commit is contained in:
Brandy Carney
2016-08-10 11:11:59 -04:00
parent e244d09eaa
commit 54a33e08e7
5 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
src/components/action-sheet/action-sheet.ts
View File

@ -150,24 +150,23 @@ export class ActionSheet extends ViewController {
* *
* ActionSheet create options * ActionSheet create options
* *
* | Option | Type | Description | * | Option | Type | Description |
* |-----------------------|------------|-----------------------------------------------------------------| * |-----------------------|------------|--------------------------------------------------------------------|
* | title |`string` | The title for the actionsheet | * | title |`string` | The title for the Action Sheet. |
* | subTitle |`string` | The sub-title for the actionsheet | * | subTitle |`string` | The sub-title for the Action Sheet. |
* | cssClass |`string` | An additional class for custom styles | * | cssClass |`string` | Additional classes for custom styles, separated by spaces. |
* | enableBackdropDismiss |`boolean` | If the actionsheet should close when the user taps the backdrop | * | enableBackdropDismiss |`boolean` | If the Action Sheet should close when the user taps the backdrop. |
* | buttons |`array<any>`| An array of buttons to display | * | buttons |`array<any>`| An array of buttons to display. |
* *
* ActionSheet button options * ActionSheet button options
* *
* | Option | Type | Description | * | Option | Type | Description |
* |----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------| * |----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------|
* | text | `string` | The buttons text | * | text | `string` | The buttons text. |
* | icon | `icon` | The buttons icons | * | icon | `icon` | The buttons icons. |
* | handler | `any` | An express the button should evaluate | * | handler | `any` | An express the button should evaluate. |
* | cssClass | `string` | An additional class for custom styles | * | 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 | * | 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 * ### Dismissing And Async Navigation

41
src/components/alert/alert.ts
View File

@ -235,35 +235,36 @@ export class Alert extends ViewController {
* *
* | Property | Type | Description | * | Property | Type | Description |
* |-----------------------|-----------|---------------------------------------------------------------------------| * |-----------------------|-----------|---------------------------------------------------------------------------|
* | title | `string` | The string for the alert (optional) | * | title | `string` | The title for the alert. |
* | subTitle | `string` | The subtitle for the alert (optional) | * | subTitle | `string` | The subtitle for the alert. |
* | message | `string` | The message for the alert (optional) | * | message | `string` | The message for the alert. |
* | cssClass | `string` | Any additional class for the alert (optional) | * | cssClass | `string` | Additional classes for custom styles, separated by spaces. |
* | inputs | `array` | An array of inputs for the alert. See input options. (optional) | * | inputs | `array` | An array of inputs for the alert. See input options. |
* | buttons | `array` | An array of buttons for the alert. See buttons options. (optional) | * | buttons | `array` | An array of buttons for the alert. See buttons options. |
* | enableBackdropDismiss | `boolean` | Whether the alert should be dismissed by tapping the backdrop (optional) | * | enableBackdropDismiss | `boolean` | Whether the alert should be dismissed by tapping the backdrop. |
* *
* *
* Input options * Input options
* *
* | Property | Type | Description | * | Property | Type | Description |
* |-------------|-----------|-----------------------------------------------------------------| * |-------------|-----------|-----------------------------------------------------------------|
* | type | `string` | The type the input should be, text, tel, number, etc (optional) | * | type | `string` | The type the input should be: text, tel, number, etc. |
* | name | `string` | The name for the input (optional) | * | name | `string` | The name for the input. |
* | placeholder | `string` | The input's placeholder (optional, for textual/numeric inputs) | * | placeholder | `string` | The input's placeholder (for textual/numeric inputs) |
* | value | `string` | The input's value (optional) | * | value | `string` | The input's value. |
* | label | `string` | The input's label (optional, only for radio/checkbox inputs) | * | label | `string` | The input's label (only for radio/checkbox inputs) |
* | checked | `boolean` | Whether or not the input is checked or not (optional) | * | checked | `boolean` | Whether or not the input is checked. |
* | id | `string` | The input's id (optional) | * | id | `string` | The input's id. |
* *
* Button options * Button options
* *
* | Property | Type | Description | * | Property | Type | Description |
* |----------|----------|----------------------------------------------------------------| * |----------|----------|-----------------------------------------------------------------|
* | text | `string` | The buttons displayed text | * | text | `string` | The buttons displayed text. |
* | handler | `any` | Expression that should be evaluated when the button is pressed | * | handler | `any` | Expression that should be evaluated when the button is pressed. |
* | cssClass | `string` | An additional CSS class for the button | * | cssClass | `string` | An additional CSS class for the button. |
* | role | `string` | The buttons role, null or `cancel` | * | role | `string` | The buttons role, null or `cancel`. |
*
* ### Dismissing And Async Navigation * ### Dismissing And Async Navigation
* *
* After an alert has been dismissed, the app may need to also transition * After an alert has been dismissed, the app may need to also transition

2
src/components/loading/loading.ts
View File

@ -158,7 +158,7 @@ export class Loading extends ViewController {
* |-----------------------|------------|------------------------------------------------------------------------------------------------------------------| * |-----------------------|------------|------------------------------------------------------------------------------------------------------------------|
* | spinner |`string` | The name of the SVG spinner for the loading indicator. | * | spinner |`string` | The name of the SVG spinner for the loading indicator. |
* | content |`string` | The html content 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. | * | showBackdrop |`boolean` | Whether to show the backdrop. Default true. |
* | dismissOnPageChange |`boolean` | Whether to dismiss the indicator when navigating to a new page. Default false. | * | 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. | * | duration |`number` | How many milliseconds to wait before hiding the indicator. By default, it will show until `dismiss()` is called. |

2
src/components/popover/popover.ts
View File

@ -151,7 +151,7 @@ export class Popover extends ViewController {
* *
* | Option | Type | Description | * | 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. | * | showBackdrop |`boolean` | Whether to show the backdrop. Default true. |
* | enableBackdropDismiss |`boolean` | Whether the popover should be dismissed by tapping the backdrop. Default true. | * | enableBackdropDismiss |`boolean` | Whether the popover should be dismissed by tapping the backdrop. Default true. |
* *

2
src/components/toast/toast.ts
View File

@ -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. | * | 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. | * | 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". | * | 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. | * | showCloseButton | `boolean` | false | Whether or not to show a button to close the toast. |
* | closeButtonText | `string` | "Close" | Text to display in the close button. | * | closeButtonText | `string` | "Close" | Text to display in the close button. |
* | dismissOnPageChange | `boolean` | false | Whether to dismiss the toast when navigating to a new page. | * | dismissOnPageChange | `boolean` | false | Whether to dismiss the toast when navigating to a new page. |