javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +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

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

@@ -3964,6 +3964,9 @@ export namespace Components {
}
interface IonSegmentButton {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'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).
@@ -3983,6 +3986,9 @@ export namespace Components {
'value': string;
}
interface IonSegmentButtonAttributes extends StencilHTMLAttributes {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'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).

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

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

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

@@ -16,20 +16,20 @@ A button's `role` property can either be `destructive` or `cancel`. Buttons with
## Properties
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `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` |
| `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[]` |
| `enterAnimation` | -- | Animation to use when the action sheet is presented. | `AnimationBuilder` |
| `header` | `header` | Title for the action sheet. | `string` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the action sheet is dismissed. | `AnimationBuilder` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `overlayIndex` | `overlay-index` | | `number` |
| `subHeader` | `sub-header` | Subtitle for the action sheet. | `string` |
| `translucent` | `translucent` | If `true`, the action sheet will be translucent. Defaults to `false`. | `boolean` |
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `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` |
| `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[]` |
| `enterAnimation` | -- | Animation to use when the action sheet is presented. | `AnimationBuilder` |
| `header` | `header` | Title for the action sheet. | `string` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the action sheet is dismissed. | `AnimationBuilder` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `overlayIndex` | `overlay-index` | | `number` |
| `subHeader` | `sub-header` | Subtitle for the action sheet. | `string` |
| `translucent` | `translucent` | If `true`, the action sheet will be translucent. Defaults to `false`. | `boolean` |
## Events
@@ -52,10 +52,10 @@ Dismiss the action sheet overlay after it has been presented.
#### Parameters
| Name | Type | Description |
| ------ | -------------------- | ----------- |
| `data` | `any` | |
| `role` | `string | undefined` | |
| Name | Type | Description |
| ------ | --------------------- | ----------- |
| `data` | `any` | |
| `role` | `string \| undefined` | |
#### Returns

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

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

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

@@ -25,22 +25,22 @@ Alerts can also include several different inputs whose data can be passed back t
## Properties
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------------------- |
| `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` |
| `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[]` |
| `enterAnimation` | -- | Animation to use when the alert is presented. | `AnimationBuilder` |
| `header` | `header` | The main title in the heading of the alert. | `string` |
| `inputs` | -- | Array of input to show in the alert. | `AlertInput[]` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the alert is dismissed. | `AnimationBuilder` |
| `message` | `message` | The main message to be displayed in the alert. | `string` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `overlayIndex` | `overlay-index` | | `number` |
| `subHeader` | `sub-header` | The subtitle in the heading of the alert. Displayed under the title. | `string` |
| `translucent` | `translucent` | If `true`, the alert will be translucent. Defaults to `false`. | `boolean` |
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `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` |
| `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[]` |
| `enterAnimation` | -- | Animation to use when the alert is presented. | `AnimationBuilder` |
| `header` | `header` | The main title in the heading of the alert. | `string` |
| `inputs` | -- | Array of input to show in the alert. | `AlertInput[]` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the alert is dismissed. | `AnimationBuilder` |
| `message` | `message` | The main message to be displayed in the alert. | `string` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `overlayIndex` | `overlay-index` | | `number` |
| `subHeader` | `sub-header` | The subtitle in the heading of the alert. Displayed under the title. | `string` |
| `translucent` | `translucent` | If `true`, the alert will be translucent. Defaults to `false`. | `boolean` |
## Events
@@ -63,10 +63,10 @@ Dismiss the alert overlay after it has been presented.
#### Parameters
| Name | Type | Description |
| ------ | -------------------- | ----------- |
| `data` | `any` | |
| `role` | `string | undefined` | |
| Name | Type | Description |
| ------ | --------------------- | ----------- |
| `data` | `any` | |
| `role` | `string \| undefined` | |
#### Returns

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

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

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

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

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

@@ -9,16 +9,54 @@ If the FAB button is not wrapped with `<ion-fab>`, it will scroll with the conte
## Properties
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| `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` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the fab button. Defaults to `false`. | `boolean` |
| `href` | `href` | Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. | `string` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `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` |
| `translucent` | `translucent` | If `true`, the fab button will be translucent. Defaults to `false`. | `boolean` |
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `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` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the fab button. Defaults to `false`. | `boolean` |
| `href` | `href` | Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. | `string` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `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` |
| `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` |
| `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
@@ -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. |
## CSS Custom Properties
| Name | Description |
| --------- | ------------------ |
| `--color` | Color of the label |
----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)*

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

@@ -16,9 +16,9 @@ Create a loading overlay with loading options.
#### Parameters
| Name | Type | Description |
| ------ | ---------------------------- | ----------- |
| `opts` | `LoadingOptions | undefined` | |
| Name | Type | Description |
| ------ | ----------------------------- | ----------- |
| `opts` | `LoadingOptions \| undefined` | |
#### Returns
@@ -32,11 +32,11 @@ Dismiss the open loading overlay.
#### Parameters
| Name | Type | Description |
| ------ | -------------------- | ----------- |
| `data` | `any` | |
| `role` | `string | undefined` | |
| `id` | `string | undefined` | |
| Name | Type | Description |
| ------ | --------------------- | ----------- |
| `data` | `any` | |
| `role` | `string \| undefined` | |
| `id` | `string \| undefined` | |
#### Returns

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

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

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

@@ -15,9 +15,9 @@ that is open. If a menu is specified, it will close that menu.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -34,10 +34,10 @@ will also automatically disable all the others that are on the same side.
#### Parameters
| Name | Type | Description |
| -------------- | --------------------------- | ----------- |
| `shouldEnable` | `boolean` | |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------------- | ----------------------------- | ----------- |
| `shouldEnable` | `boolean` | |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -55,9 +55,9 @@ return `null`.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -101,9 +101,9 @@ Returns `true` if the specified menu is enabled.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -118,9 +118,9 @@ will return true if any menu is currently open.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -134,9 +134,9 @@ Open the menu.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -171,10 +171,10 @@ Used to enable or disable the ability to swipe open the menu.
#### Parameters
| Name | Type | Description |
| -------------- | --------------------------- | ----------- |
| `shouldEnable` | `boolean` | |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------------- | ----------------------------- | ----------- |
| `shouldEnable` | `boolean` | |
| `menuId` | `string \| null \| undefined` | |
#### Returns
@@ -189,9 +189,9 @@ will close.
#### Parameters
| Name | Type | Description |
| -------- | --------------------------- | ----------- |
| `menuId` | `string | null | undefined` | |
| Name | Type | Description |
| -------- | ----------------------------- | ----------- |
| `menuId` | `string \| null \| undefined` | |
#### Returns

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -157,10 +157,10 @@ Transition to the next slide.
#### Parameters
| Name | Type | Description |
| -------------- | --------------------- | ----------- |
| `speed` | `number | undefined` | |
| `runCallbacks` | `boolean | undefined` | |
| Name | Type | Description |
| -------------- | ---------------------- | ----------- |
| `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean \| undefined` | |
#### Returns
@@ -174,10 +174,10 @@ Transition to the previous slide.
#### Parameters
| Name | Type | Description |
| -------------- | --------------------- | ----------- |
| `speed` | `number | undefined` | |
| `runCallbacks` | `boolean | undefined` | |
| Name | Type | Description |
| -------------- | ---------------------- | ----------- |
| `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean \| undefined` | |
#### Returns
@@ -191,11 +191,11 @@ Transition to the specified slide.
#### Parameters
| Name | Type | Description |
| -------------- | --------------------- | ----------- |
| `index` | `number` | |
| `speed` | `number | undefined` | |
| `runCallbacks` | `boolean | undefined` | |
| Name | Type | Description |
| -------------- | ---------------------- | ----------- |
| `index` | `number` | |
| `speed` | `number \| undefined` | |
| `runCallbacks` | `boolean \| undefined` | |
#### Returns

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

@@ -54,9 +54,9 @@ Get the tab at the given index
#### Parameters
| Name | Type | Description |
| ------------ | ------------------------------------- | ----------- |
| `tabOrIndex` | `string | number | HTMLIonTabElement` | |
| Name | Type | Description |
| ------------ | --------------------------------------- | ----------- |
| `tabOrIndex` | `string \| number \| HTMLIonTabElement` | |
#### Returns
@@ -70,9 +70,9 @@ Index or the Tab instance, of the tab to select.
#### Parameters
| Name | Type | Description |
| ------------ | ---------------------------- | ----------- |
| `tabOrIndex` | `number | HTMLIonTabElement` | |
| Name | Type | Description |
| ------------ | ----------------------------- | ----------- |
| `tabOrIndex` | `number \| HTMLIonTabElement` | |
#### 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` |
## CSS Custom Properties
| Name | Description |
| --------- | ----------------------- |
| `--color` | Text color of the title |
----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)*

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

@@ -14,9 +14,9 @@ Create a toast overlay with toast options.
#### Parameters
| Name | Type | Description |
| ------ | -------------------------- | ----------- |
| `opts` | `ToastOptions | undefined` | |
| Name | Type | Description |
| ------ | --------------------------- | ----------- |
| `opts` | `ToastOptions \| undefined` | |
#### Returns
@@ -30,11 +30,11 @@ Dismiss the open toast overlay.
#### Parameters
| Name | Type | Description |
| ------ | -------------------- | ----------- |
| `data` | `any` | |
| `role` | `string | undefined` | |
| `id` | `string | undefined` | |
| Name | Type | Description |
| ------ | --------------------- | ----------- |
| `data` | `any` | |
| `role` | `string \| undefined` | |
| `id` | `string \| undefined` | |
#### Returns

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

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