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

chore(): update stencil

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-10-11 16:49:05 -05:00
parent c7267e1d52
commit fb3b752198
29 changed files with 306 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/package.json
View File

@ -30,7 +30,7 @@
"ionicons": "4.4.4" "ionicons": "4.4.4"
}, },
"devDependencies": { "devDependencies": {
"@stencil/core": "0.14.0-1", "@stencil/core": "0.14.0-2",
"@stencil/dev-server": "latest", "@stencil/dev-server": "latest",
"@stencil/sass": "0.1.1", "@stencil/sass": "0.1.1",
"@stencil/utils": "latest", "@stencil/utils": "latest",

6
core/src/components.d.ts vendored
View File

@ -3964,6 +3964,9 @@ export namespace Components {
} }
interface IonSegmentButton { interface IonSegmentButton {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'checked': boolean; 'checked': boolean;
/** /**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
@ -3983,6 +3986,9 @@ export namespace Components {
'value': string; 'value': string;
} }
interface IonSegmentButtonAttributes extends StencilHTMLAttributes { interface IonSegmentButtonAttributes extends StencilHTMLAttributes {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'checked'?: boolean; 'checked'?: boolean;
/** /**
* The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).

6
core/src/components/action-sheet-controller/readme.md
View File

@ -30,10 +30,10 @@ Dismiss the open action sheet overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

8
core/src/components/action-sheet/readme.md
View File

@ -17,10 +17,10 @@ A button's `role` property can either be `destructive` or `cancel`. Buttons with
## Properties ## Properties
| Property | Attribute | Description | Type | | Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------------- | | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `animated` | `animated` | If `true`, the action sheet will animate. Defaults to `true`. | `boolean` | | `animated` | `animated` | If `true`, the action sheet will animate. Defaults to `true`. | `boolean` |
| `backdropDismiss` | `backdrop-dismiss` | If `true`, the action sheet will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` | | `backdropDismiss` | `backdrop-dismiss` | If `true`, the action sheet will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` |
| `buttons` | -- | An array of buttons for the action sheet. | `(ActionSheetButton | string)[]` | | `buttons` | -- | An array of buttons for the action sheet. | `(ActionSheetButton \| string)[]` |
| `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string`, `string[]` | | `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string`, `string[]` |
| `enterAnimation` | -- | Animation to use when the action sheet is presented. | `AnimationBuilder` | | `enterAnimation` | -- | Animation to use when the action sheet is presented. | `AnimationBuilder` |
| `header` | `header` | Title for the action sheet. | `string` | | `header` | `header` | Title for the action sheet. | `string` |
@ -53,9 +53,9 @@ Dismiss the action sheet overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

6
core/src/components/alert-controller/readme.md
View File

@ -47,10 +47,10 @@ Dismiss the open alert overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

8
core/src/components/alert/readme.md
View File

@ -26,10 +26,10 @@ Alerts can also include several different inputs whose data can be passed back t
## Properties ## Properties
| Property | Attribute | Description | Type | | Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------- | | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `animated` | `animated` | If `true`, the alert will animate. Defaults to `true`. | `boolean` | | `animated` | `animated` | If `true`, the alert will animate. Defaults to `true`. | `boolean` |
| `backdropDismiss` | `backdrop-dismiss` | If `true`, the alert will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` | | `backdropDismiss` | `backdrop-dismiss` | If `true`, the alert will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` |
| `buttons` | -- | Array of buttons to be added to the alert. | `(AlertButton | string)[]` | | `buttons` | -- | Array of buttons to be added to the alert. | `(AlertButton \| string)[]` |
| `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string`, `string[]` | | `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string`, `string[]` |
| `enterAnimation` | -- | Animation to use when the alert is presented. | `AnimationBuilder` | | `enterAnimation` | -- | Animation to use when the alert is presented. | `AnimationBuilder` |
| `header` | `header` | The main title in the heading of the alert. | `string` | | `header` | `header` | The main title in the heading of the alert. | `string` |
@ -64,9 +64,9 @@ Dismiss the alert overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/animation-controller/readme.md
View File

@ -16,8 +16,8 @@ Creates an animation instance
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------------ | ------------------------------ | ----------- | | ------------------ | ------------------------------- | ----------- |
| `animationBuilder` | `AnimationBuilder | undefined` | | | `animationBuilder` | `AnimationBuilder \| undefined` | |
| `baseEl` | `any` | | | `baseEl` | `any` | |
| `opts` | `any` | | | `opts` | `any` | |

6
core/src/components/content/readme.md
View File

@ -86,9 +86,9 @@ Scroll to a specified X/Y location in the component
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ---------- | --------------------------- | ----------- | | ---------- | ----------------------------- | ----------- |
| `x` | `number | null | undefined` | | | `x` | `number \| null \| undefined` | |
| `y` | `number | null | undefined` | | | `y` | `number \| null \| undefined` | |
| `duration` | `number` | | | `duration` | `number` | |
#### Returns #### Returns

40
core/src/components/fab-button/readme.md
View File

@ -10,7 +10,7 @@ If the FAB button is not wrapped with `<ion-fab>`, it will scroll with the conte
## Properties ## Properties
| Property | Attribute | Description | Type | | Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `activated` | `activated` | If `true`, the fab button will be show a close icon. Defaults to `false`. | `boolean` | | `activated` | `activated` | If `true`, the fab button will be show a close icon. Defaults to `false`. | `boolean` |
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` | | `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the fab button. Defaults to `false`. | `boolean` | | `disabled` | `disabled` | If `true`, the user cannot interact with the fab button. Defaults to `false`. | `boolean` |
@ -19,6 +19,44 @@ If the FAB button is not wrapped with `<ion-fab>`, it will scroll with the conte
| `routerDirection` | `router-direction` | When using a router, it specifies the transition direction when navigating to another page using `href`. | `RouterDirection` | | `routerDirection` | `router-direction` | When using a router, it specifies the transition direction when navigating to another page using `href`. | `RouterDirection` |
| `show` | `show` | If `true`, the fab button will show when in a fab-list. | `boolean` | | `show` | `show` | If `true`, the fab button will show when in a fab-list. | `boolean` |
| `translucent` | `translucent` | If `true`, the fab button will be translucent. Defaults to `false`. | `boolean` | | `translucent` | `translucent` | If `true`, the fab button will be translucent. Defaults to `false`. | `boolean` |
| `type` | `type` | The type of the button. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"` | `"submit"`, `"reset"`, `"button"` |
## Events
| Event | Description |
| ---------- | ------------------------------------ |
| `ionBlur` | Emitted when the button loses focus. |
| `ionFocus` | Emitted when the button has focus. |
## CSS Custom Properties
| Name | Description |
| ------------------------ | --------------------------------------- |
| `--background` | Background of the button |
| `--background-activated` | Background of the button when activated |
| `--background-focused` | Background of the button when focused |
| `--border-color` | Border color of the button |
| `--border-radius` | Border radius of the button |
| `--border-style` | Border style of the button |
| `--border-width` | Border width of the button |
| `--box-shadow` | Box shadow of the button |
| `--color` | Text color of the button |
| `--color-activated` | Text color of the button when activated |
| `--color-focused` | Text color of the button when focused |
| `--height` | Height of the button |
| `--margin-bottom` | Margin bottom of the button |
| `--margin-end` | Margin end of the button |
| `--margin-start` | Margin start of the button |
| `--margin-top` | Margin top of the button |
| `--padding-bottom` | Padding bottom of the button |
| `--padding-end` | Padding end of the button |
| `--padding-start` | Padding start of the button |
| `--padding-top` | Padding top of the button |
| `--ripple-color` | Color of the button ripple effect |
| `--transition` | Transition of the button |
| `--width` | Width of the button |
---------------------------------------------- ----------------------------------------------

9
core/src/components/label/readme.md
View File

@ -12,7 +12,7 @@ Label is a wrapper element that can be used in combination with `ion-item`, `ion
| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` | | `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` | | `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `position` | `position` | The position determines where and how the label behaves inside an item. Possible values are: 'inline' | 'fixed' | 'stacked' | 'floating' | `"fixed"`, `"stacked"`, `"floating"` | | `position` | `position` | The position determines where and how the label behaves inside an item. Possible values are: 'inline' \| 'fixed' \| 'stacked' \| 'floating' | `"fixed"`, `"stacked"`, `"floating"` |
## Events ## Events
@ -22,6 +22,13 @@ Label is a wrapper element that can be used in combination with `ion-item`, `ion
| `ionStyle` | Emitted when the styles change. | | `ionStyle` | Emitted when the styles change. |
## CSS Custom Properties
| Name | Description |
| --------- | ------------------ |
| `--color` | Color of the label |
---------------------------------------------- ----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)* *Built with [StencilJS](https://stenciljs.com/)*

10
core/src/components/loading-controller/readme.md
View File

@ -17,8 +17,8 @@ Create a loading overlay with loading options.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | ---------------------------- | ----------- | | ------ | ----------------------------- | ----------- |
| `opts` | `LoadingOptions | undefined` | | | `opts` | `LoadingOptions \| undefined` | |
#### Returns #### Returns
@ -33,10 +33,10 @@ Dismiss the open loading overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/loading/readme.md
View File

@ -56,9 +56,9 @@ Dismiss the loading overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

32
core/src/components/menu-controller/readme.md
View File

@ -16,8 +16,8 @@ that is open. If a menu is specified, it will close that menu.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -35,9 +35,9 @@ will also automatically disable all the others that are on the same side.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------------- | --------------------------- | ----------- | | -------------- | ----------------------------- | ----------- |
| `shouldEnable` | `boolean` | | | `shouldEnable` | `boolean` | |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -56,8 +56,8 @@ return `null`.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -102,8 +102,8 @@ Returns `true` if the specified menu is enabled.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -119,8 +119,8 @@ will return true if any menu is currently open.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -135,8 +135,8 @@ Open the menu.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -172,9 +172,9 @@ Used to enable or disable the ability to swipe open the menu.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------------- | --------------------------- | ----------- | | -------------- | ----------------------------- | ----------- |
| `shouldEnable` | `boolean` | | | `shouldEnable` | `boolean` | |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns
@ -190,8 +190,8 @@ will close.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------- | ----------- | | -------- | ----------------------------- | ----------- |
| `menuId` | `string | null | undefined` | | | `menuId` | `string \| null \| undefined` | |
#### Returns #### Returns

6
core/src/components/modal-controller/readme.md
View File

@ -31,10 +31,10 @@ Dismiss the open modal overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/modal/readme.md
View File

@ -51,9 +51,9 @@ Dismiss the modal overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

74
core/src/components/nav/readme.md
View File

@ -37,8 +37,8 @@ Returns `true` or false if the current view can go back
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | ---------------------------- | ----------- | | ------ | ----------------------------- | ----------- |
| `view` | `ViewController | undefined` | | | `view` | `ViewController \| undefined` | |
#### Returns #### Returns
@ -79,8 +79,8 @@ Gets the previous view
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | ---------------------------- | ----------- | | ------ | ----------------------------- | ----------- |
| `view` | `ViewController | undefined` | | | `view` | `ViewController \| undefined` | |
#### Returns #### Returns
@ -105,12 +105,12 @@ Inserts a component into the nav stack at the specified index. This is useful if
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ---------------- | -------------------------------------- | ----------- | | ---------------- | ---------------------------------------- | ----------- |
| `insertIndex` | `number` | | | `insertIndex` | `number` | |
| `component` | `T` | | | `component` | `T` | |
| `componentProps` | `ComponentProps<T> | null | undefined` | | | `componentProps` | `ComponentProps<T> \| null \| undefined` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -125,11 +125,11 @@ Inserts an array of components into the nav stack at the specified index. The la
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------------ | ------------------------------- | ----------- | | ------------------ | --------------------------------- | ----------- |
| `insertIndex` | `number` | | | `insertIndex` | `number` | |
| `insertComponents` | `NavComponent[]` | | | `insertComponents` | `NavComponent[]` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -144,9 +144,9 @@ Call to navigate back from a current component. Similar to push(), you can also
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | ------------------------------- | ----------- | | ------ | --------------------------------- | ----------- |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -161,10 +161,10 @@ Pop to a specific index in the navigation stack
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ----------------- | ------------------------------- | ----------- | | ----------------- | --------------------------------- | ----------- |
| `indexOrViewCtrl` | `number | ViewController` | | | `indexOrViewCtrl` | `number \| ViewController` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -179,9 +179,9 @@ Navigate back to the root of the stack, no matter how far back that is.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | ------------------------------- | ----------- | | ------ | --------------------------------- | ----------- |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -196,11 +196,11 @@ Push a new component onto the current navigation stack. Pass any additional info
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ---------------- | -------------------------------------- | ----------- | | ---------------- | ---------------------------------------- | ----------- |
| `component` | `T` | | | `component` | `T` | |
| `componentProps` | `ComponentProps<T> | null | undefined` | | | `componentProps` | `ComponentProps<T> \| null \| undefined` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -215,11 +215,11 @@ Removes a page from the nav stack at the specified index.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------- | ------------------------------- | ----------- | | ------------- | --------------------------------- | ----------- |
| `startIndex` | `number` | | | `startIndex` | `number` | |
| `removeCount` | `number` | | | `removeCount` | `number` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -234,10 +234,10 @@ Set the views of the current navigation stack and navigate to the last view. By
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------- | ------------------------------- | ----------- | | ------- | --------------------------------- | ----------- |
| `views` | `any[]` | | | `views` | `any[]` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -252,11 +252,11 @@ Set the root for the current navigation stack.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ---------------- | -------------------------------------- | ----------- | | ---------------- | ---------------------------------------- | ----------- |
| `component` | `T` | | | `component` | `T` | |
| `componentProps` | `ComponentProps<T> | null | undefined` | | | `componentProps` | `ComponentProps<T> \| null \| undefined` | |
| `opts` | `NavOptions | null | undefined` | | | `opts` | `NavOptions \| null \| undefined` | |
| `done` | `TransitionDoneFn | undefined` | | | `done` | `TransitionDoneFn \| undefined` | |
#### Returns #### Returns
@ -271,9 +271,9 @@ Type: `Promise<boolean>`
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------------------------------------- | ----------- | | ----------- | -------------------------------------- | ----------- |
| `id` | `string` | | | `id` | `string` | |
| `params` | `{ [key: string]: any; } | undefined` | | | `params` | `{ [key: string]: any; } \| undefined` | |
| `direction` | `number` | | | `direction` | `number` | |
#### Returns #### Returns

6
core/src/components/picker-controller/readme.md
View File

@ -30,10 +30,10 @@ Dismiss the open picker overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/picker/readme.md
View File

@ -46,9 +46,9 @@ Dismiss the picker overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

6
core/src/components/popover-controller/readme.md
View File

@ -31,10 +31,10 @@ Dismiss the open popover overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/popover/readme.md
View File

@ -55,9 +55,9 @@ Dismiss the popover overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/reorder-group/readme.md
View File

@ -73,8 +73,8 @@ to complete the reorder operation.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| --------------- | ----------------------------- | ----------- | | --------------- | ------------------------------- | ----------- |
| `listOrReorder` | `boolean | any[] | undefined` | | | `listOrReorder` | `boolean \| any[] \| undefined` | |
#### Returns #### Returns

16
core/src/components/router-outlet/readme.md
View File

@ -29,10 +29,10 @@ While RouterOutlet has methods for navigating around, it's recommended to use th
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------ | --------------------------------- | ----------- | | ------------ | ---------------------------------- | ----------- |
| `enteringEl` | `HTMLElement` | | | `enteringEl` | `HTMLElement` | |
| `leavingEl` | `HTMLElement | undefined` | | | `leavingEl` | `HTMLElement \| undefined` | |
| `opts` | `RouterOutletOptions | undefined` | | | `opts` | `RouterOutletOptions \| undefined` | |
#### Returns #### Returns
@ -57,10 +57,10 @@ Set the root component for the given navigation stack
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------------------------------------- | ----------- | | ----------- | -------------------------------------- | ----------- |
| `component` | `ComponentRef` | | | `component` | `ComponentRef` | |
| `params` | `{ [key: string]: any; } | undefined` | | | `params` | `{ [key: string]: any; } \| undefined` | |
| `opts` | `RouterOutletOptions | undefined` | | | `opts` | `RouterOutletOptions \| undefined` | |
#### Returns #### Returns
@ -75,9 +75,9 @@ Type: `Promise<boolean>`
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------------------------------------- | ----------- | | ----------- | -------------------------------------- | ----------- |
| `id` | `string` | | | `id` | `string` | |
| `params` | `{ [key: string]: any; } | undefined` | | | `params` | `{ [key: string]: any; } \| undefined` | |
| `direction` | `number` | | | `direction` | `number` | |
#### Returns #### Returns

2
core/src/components/segment-button/readme.md
View File

@ -10,7 +10,7 @@ Segment buttons are groups of related buttons inside of a [Segment](../../segmen
| Property | Attribute | Description | Type | | Property | Attribute | Description | Type |
| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `checked` | `checked` | | `boolean` | | `checked` | `checked` | If `true`, the segment button is selected. Defaults to `false`. | `boolean` |
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` | | `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the segment button. Default false. | `boolean` | | `disabled` | `disabled` | If `true`, the user cannot interact with the segment button. Default false. | `boolean` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` | | `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |

4
core/src/components/select/readme.md
View File

@ -77,8 +77,8 @@ based in `ion-select` settings.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ---- | --------------------- | ----------- | | ---- | ---------------------- | ----------- |
| `ev` | `UIEvent | undefined` | | | `ev` | `UIEvent \| undefined` | |
#### Returns #### Returns

18
core/src/components/slides/readme.md
View File

@ -158,9 +158,9 @@ Transition to the next slide.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------------- | --------------------- | ----------- | | -------------- | ---------------------- | ----------- |
| `speed` | `number | undefined` | | | `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean | undefined` | | | `runCallbacks` | `boolean \| undefined` | |
#### Returns #### Returns
@ -175,9 +175,9 @@ Transition to the previous slide.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------------- | --------------------- | ----------- | | -------------- | ---------------------- | ----------- |
| `speed` | `number | undefined` | | | `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean | undefined` | | | `runCallbacks` | `boolean \| undefined` | |
#### Returns #### Returns
@ -192,10 +192,10 @@ Transition to the specified slide.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| -------------- | --------------------- | ----------- | | -------------- | ---------------------- | ----------- |
| `index` | `number` | | | `index` | `number` | |
| `speed` | `number | undefined` | | | `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean | undefined` | | | `runCallbacks` | `boolean \| undefined` | |
#### Returns #### Returns

8
core/src/components/tabs/readme.md
View File

@ -55,8 +55,8 @@ Get the tab at the given index
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------ | ------------------------------------- | ----------- | | ------------ | --------------------------------------- | ----------- |
| `tabOrIndex` | `string | number | HTMLIonTabElement` | | | `tabOrIndex` | `string \| number \| HTMLIonTabElement` | |
#### Returns #### Returns
@ -71,8 +71,8 @@ Index or the Tab instance, of the tab to select.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------------ | ---------------------------- | ----------- | | ------------ | ----------------------------- | ----------- |
| `tabOrIndex` | `number | HTMLIonTabElement` | | | `tabOrIndex` | `number \| HTMLIonTabElement` | |
#### Returns #### Returns

7
core/src/components/title/readme.md
View File

@ -14,6 +14,13 @@
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` | | `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` |
## CSS Custom Properties
| Name | Description |
| --------- | ----------------------- |
| `--color` | Text color of the title |
---------------------------------------------- ----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)* *Built with [StencilJS](https://stenciljs.com/)*

10
core/src/components/toast-controller/readme.md
View File

@ -15,8 +15,8 @@ Create a toast overlay with toast options.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------------- | ----------- | | ------ | --------------------------- | ----------- |
| `opts` | `ToastOptions | undefined` | | | `opts` | `ToastOptions \| undefined` | |
#### Returns #### Returns
@ -31,10 +31,10 @@ Dismiss the open toast overlay.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
| `id` | `string | undefined` | | | `id` | `string \| undefined` | |
#### Returns #### Returns

4
core/src/components/toast/readme.md
View File

@ -58,9 +58,9 @@ Dismiss the toast overlay after it has been presented.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------- | ----------- | | ------ | --------------------- | ----------- |
| `data` | `any` | | | `data` | `any` | |
| `role` | `string | undefined` | | | `role` | `string \| undefined` | |
#### Returns #### Returns