diff --git a/core/src/components.d.ts b/core/src/components.d.ts index aa852472c6..339e996007 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -1660,7 +1660,7 @@ export namespace Components { interface IonInfiniteScroll { /** - * Call `complete()` within the `infinite` output event handler when your async operation has completed. For example, the `loading` state is while the app is performing an asynchronous operation, such as receiving more data from an AJAX request to add more items to a data list. Once the data has been received and UI updated, you then call this method to signify that the loading has completed. This method will change the infinite scroll's state from `loading` to `enabled`. + * Call `complete()` within the `ionInfinite` output event handler when your async operation has completed. For example, the `loading` state is while the app is performing an asynchronous operation, such as receiving more data from an AJAX request to add more items to a data list. Once the data has been received and UI updated, you then call this method to signify that the loading has completed. This method will change the infinite scroll's state from `loading` to `enabled`. */ 'complete': () => void; /** diff --git a/core/src/components/action-sheet-controller/readme.md b/core/src/components/action-sheet-controller/readme.md index 62b908efad..d2d2f74a9f 100644 --- a/core/src/components/action-sheet-controller/readme.md +++ b/core/src/components/action-sheet-controller/readme.md @@ -7,11 +7,49 @@ Action Sheet controllers programmatically control the action sheet component. Ac ## Methods -| Method | Description | -| --------- | --------------------------------------------------------- | -| `create` | Create an action sheet overlay with action sheet options. | -| `dismiss` | Dismiss the open action sheet overlay. | -| `getTop` | Get the most recently opened action sheet overlay. | +### `create(opts: ActionSheetOptions) => Promise` + +Create an action sheet overlay with action sheet options. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `opts` | `ActionSheetOptions` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open action sheet overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened action sheet overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/action-sheet/readme.md b/core/src/components/action-sheet/readme.md index a7e2059c89..6abd7bfdd7 100644 --- a/core/src/components/action-sheet/readme.md +++ b/core/src/components/action-sheet/readme.md @@ -46,12 +46,52 @@ A button's `role` property can either be `destructive` or `cancel`. Buttons with ## Methods -| Method | Description | -| --------------- | ------------------------------------------------------------------- | -| `dismiss` | Dismiss the action sheet overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the action-sheet did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the action-sheet will dismiss. | -| `present` | Present the action sheet overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the action sheet overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the action-sheet did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the action-sheet will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the action sheet overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/alert-controller/readme.md b/core/src/components/alert-controller/readme.md index bb4d14736b..86843e7d00 100644 --- a/core/src/components/alert-controller/readme.md +++ b/core/src/components/alert-controller/readme.md @@ -24,11 +24,49 @@ async function presentAlert() { ## Methods -| Method | Description | -| --------- | ------------------------------------------- | -| `create` | Create an alert overlay with alert options | -| `dismiss` | Dismiss the open alert overlay. | -| `getTop` | Get the most recently opened alert overlay. | +### `create(opts: AlertOptions) => Promise` + +Create an alert overlay with alert options + +#### Parameters + +| Name | Type | Description | +| ------ | -------------- | ----------- | +| `opts` | `AlertOptions` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open alert overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened alert overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/alert/readme.md b/core/src/components/alert/readme.md index 1ce6280c65..ae05e992de 100644 --- a/core/src/components/alert/readme.md +++ b/core/src/components/alert/readme.md @@ -57,12 +57,52 @@ Alerts can also include several different inputs whose data can be passed back t ## Methods -| Method | Description | -| --------------- | ------------------------------------------------------------ | -| `dismiss` | Dismiss the alert overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the alert did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the alert will dismiss. | -| `present` | Present the alert overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the alert overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the alert did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the alert will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the alert overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/animation-controller/readme.md b/core/src/components/animation-controller/readme.md index aa9f6bbe29..c213fe68ba 100644 --- a/core/src/components/animation-controller/readme.md +++ b/core/src/components/animation-controller/readme.md @@ -9,9 +9,23 @@ Used to create an animation instance. ## Methods -| Method | Description | -| -------- | ----------------------------- | -| `create` | Creates an animation instance | +### `create(animationBuilder?: AnimationBuilder | undefined, baseEl?: any, opts?: any) => Promise` + +Creates an animation instance + +#### Parameters + +| Name | Type | Description | +| ------------------ | ------------------------------ | ----------- | +| `animationBuilder` | `AnimationBuilder | undefined` | | +| `baseEl` | `any` | | +| `opts` | `any` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/content/readme.md b/core/src/components/content/readme.md index a9029e5981..ea791f2eaf 100644 --- a/core/src/components/content/readme.md +++ b/core/src/components/content/readme.md @@ -30,13 +30,83 @@ view component. ## Methods -| Method | Description | -| ------------------ | --------------------------------------------------- | -| `getScrollElement` | | -| `scrollByPoint` | Scroll by a specified X/Y distance in the component | -| `scrollToBottom` | Scroll to the bottom of the component | -| `scrollToPoint` | Scroll to a specified X/Y location in the component | -| `scrollToTop` | Scroll to the top of the component | +### `getScrollElement() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `scrollByPoint(x: number, y: number, duration: number) => Promise` + +Scroll by a specified X/Y distance in the component + +#### Parameters + +| Name | Type | Description | +| ---------- | -------- | ----------- | +| `x` | `number` | | +| `y` | `number` | | +| `duration` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `scrollToBottom(duration?: number) => Promise` + +Scroll to the bottom of the component + +#### Parameters + +| Name | Type | Description | +| ---------- | -------- | ----------- | +| `duration` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `scrollToPoint(x: number | null | undefined, y: number | null | undefined, duration?: number) => Promise` + +Scroll to a specified X/Y location in the component + +#### Parameters + +| Name | Type | Description | +| ---------- | --------------------------- | ----------- | +| `x` | `number | null | undefined` | | +| `y` | `number | null | undefined` | | +| `duration` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `scrollToTop(duration?: number) => Promise` + +Scroll to the top of the component + +#### Parameters + +| Name | Type | Description | +| ---------- | -------- | ----------- | +| `duration` | `number` | | + +#### Returns + +Type: `Promise` + + ## CSS Custom Properties diff --git a/core/src/components/datetime/readme.md b/core/src/components/datetime/readme.md index 6dfd770aee..8d67a53a48 100644 --- a/core/src/components/datetime/readme.md +++ b/core/src/components/datetime/readme.md @@ -239,9 +239,15 @@ dates in JavaScript. ## Methods -| Method | Description | -| ------ | ----------- | -| `open` | | +### `open() => Promise` + + + +#### Returns + +Type: `Promise` + + ## CSS Custom Properties diff --git a/core/src/components/fab/readme.md b/core/src/components/fab/readme.md index 535a5ad1d5..9a7e3721f4 100644 --- a/core/src/components/fab/readme.md +++ b/core/src/components/fab/readme.md @@ -17,9 +17,15 @@ Fabs are container elements that contain one or more fab buttons. They should be ## Methods -| Method | Description | -| ------- | ---------------------------------- | -| `close` | Close an active FAB list container | +### `close() => void` + +Close an active FAB list container + +#### Returns + +Type: `void` + + ---------------------------------------------- diff --git a/core/src/components/infinite-scroll/readme.md b/core/src/components/infinite-scroll/readme.md index e39964beb3..78b32c71fe 100644 --- a/core/src/components/infinite-scroll/readme.md +++ b/core/src/components/infinite-scroll/readme.md @@ -33,9 +33,22 @@ Separating the `ion-infinite-scroll` and `ion-infinite-scroll-content` component ## Methods -| Method | Description | -| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `complete` | Call `complete()` within the `infinite` output event handler when your async operation has completed. For example, the `loading` state is while the app is performing an asynchronous operation, such as receiving more data from an AJAX request to add more items to a data list. Once the data has been received and UI updated, you then call this method to signify that the loading has completed. This method will change the infinite scroll's state from `loading` to `enabled`. | +### `complete() => void` + +Call `complete()` within the `ionInfinite` output event handler when +your async operation has completed. For example, the `loading` +state is while the app is performing an asynchronous operation, +such as receiving more data from an AJAX request to add more items +to a data list. Once the data has been received and UI updated, you +then call this method to signify that the loading has completed. +This method will change the infinite scroll's state from `loading` +to `enabled`. + +#### Returns + +Type: `void` + + ---------------------------------------------- diff --git a/core/src/components/infinite-scroll/test/top/e2e.ts b/core/src/components/infinite-scroll/test/top/e2e.ts new file mode 100644 index 0000000000..dd0e196669 --- /dev/null +++ b/core/src/components/infinite-scroll/test/top/e2e.ts @@ -0,0 +1,10 @@ +import { newE2EPage } from '@stencil/core/testing'; + +it('infinite-scroll: basic', async () => { + const page = await newE2EPage({ + url: '/src/components/infinite-scroll/test/basic?ionic:_testing=true' + }); + + const compare = await page.compareScreenshot(); + expect(compare).toMatchScreenshot(); +}); diff --git a/core/src/components/infinite-scroll/test/top/index.html b/core/src/components/infinite-scroll/test/top/index.html new file mode 100644 index 0000000000..8623a51238 --- /dev/null +++ b/core/src/components/infinite-scroll/test/top/index.html @@ -0,0 +1,77 @@ + + + + + + Infinite Scroll - Basic + + + + + + + + + + + + Infinite Scroll - Basic + + + + + + + + + + + + Toggle InfiniteScroll + + + + + + + + + + + + diff --git a/core/src/components/input/readme.md b/core/src/components/input/readme.md index 1ef57260a4..2021b6fc62 100644 --- a/core/src/components/input/readme.md +++ b/core/src/components/input/readme.md @@ -57,9 +57,15 @@ It is meant for text `type` inputs only, such as `"text"`, `"password"`, `"email ## Methods -| Method | Description | -| ---------- | ----------- | -| `setFocus` | | +### `setFocus() => void` + + + +#### Returns + +Type: `void` + + ## CSS Custom Properties diff --git a/core/src/components/item-options/readme.md b/core/src/components/item-options/readme.md index 38dd1007bb..154eb82b92 100644 --- a/core/src/components/item-options/readme.md +++ b/core/src/components/item-options/readme.md @@ -31,9 +31,15 @@ You can combine the `ionSwipe` event plus the `expandable` directive to create a ## Methods -| Method | Description | -| ---------------- | ----------- | -| `fireSwipeEvent` | | +### `fireSwipeEvent() => void` + + + +#### Returns + +Type: `void` + + ---------------------------------------------- diff --git a/core/src/components/item-sliding/readme.md b/core/src/components/item-sliding/readme.md index fbe04f8143..9dcadd40cc 100644 --- a/core/src/components/item-sliding/readme.md +++ b/core/src/components/item-sliding/readme.md @@ -45,12 +45,49 @@ Options can be expanded to take up the full width of the item if you swipe past ## Methods -| Method | Description | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `close` | Close the sliding item. Items can also be closed from the [List](../../list/List). | -| `closeOpened` | Close all of the sliding items in the list. Items can also be closed from the [List](../../list/List). | -| `getOpenAmount` | Get the amount the item is open in pixels. | -| `getSlidingRatio` | Get the ratio of the open amount of the item compared to the width of the options. If the number returned is positive, then the options on the right side are open. If the number returned is negative, then the options on the left side are open. If the absolute value of the number is greater than 1, the item is open more than the width of the options. | +### `close() => Promise` + +Close the sliding item. Items can also be closed from the [List](../../list/List). + +#### Returns + +Type: `Promise` + + + +### `closeOpened() => Promise` + +Close all of the sliding items in the list. Items can also be closed from the [List](../../list/List). + +#### Returns + +Type: `Promise` + + + +### `getOpenAmount() => Promise` + +Get the amount the item is open in pixels. + +#### Returns + +Type: `Promise` + + + +### `getSlidingRatio() => Promise` + +Get the ratio of the open amount of the item compared to the width of the options. +If the number returned is positive, then the options on the right side are open. +If the number returned is negative, then the options on the left side are open. +If the absolute value of the number is greater than 1, the item is open more than +the width of the options. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/item/readme.md b/core/src/components/item/readme.md index 13f278a8c0..b9d0b48f11 100644 --- a/core/src/components/item/readme.md +++ b/core/src/components/item/readme.md @@ -83,6 +83,8 @@ The highlight color changes based on the item state, but all of the states use I | `--box-shadow` | Box shadow of the item | | `--color` | Color of the item | | `--detail-icon-color` | Color of the item detail icon | +| `--detail-icon-font-size` | Font size of the item detail icon | +| `--detail-icon-opacity` | Opacity of the item detail icon | | `--highlight-color-focused` | The color of the highlight on the item when focused | | `--highlight-color-invalid` | The color of the highlight on the item when invalid | | `--highlight-color-valid` | The color of the highlight on the item when valid | diff --git a/core/src/components/list/readme.md b/core/src/components/list/readme.md index f12268d89f..78d258a69a 100644 --- a/core/src/components/list/readme.md +++ b/core/src/components/list/readme.md @@ -20,9 +20,15 @@ Lists support several interactions including swiping items to reveal options, dr ## Methods -| Method | Description | -| ------------------- | ----------- | -| `closeSlidingItems` | | +### `closeSlidingItems() => Promise` + + + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/loading-controller/readme.md b/core/src/components/loading-controller/readme.md index 1814e118a1..baf1d889c8 100644 --- a/core/src/components/loading-controller/readme.md +++ b/core/src/components/loading-controller/readme.md @@ -10,11 +10,49 @@ Loading controllers programmatically control the loading component. Loadings can ## Methods -| Method | Description | -| --------- | ---------------------------------------------- | -| `create` | Create a loading overlay with loading options. | -| `dismiss` | Dismiss the open loading overlay. | -| `getTop` | Get the most recently opened loading overlay. | +### `create(opts?: LoadingOptions | undefined) => Promise` + +Create a loading overlay with loading options. + +#### Parameters + +| Name | Type | Description | +| ------ | ---------------------------- | ----------- | +| `opts` | `LoadingOptions | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open loading overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened loading overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/loading/readme.md b/core/src/components/loading/readme.md index 93f2abdd15..16bc84569e 100644 --- a/core/src/components/loading/readme.md +++ b/core/src/components/loading/readme.md @@ -49,12 +49,52 @@ The loading indicator can be dismissed automatically after a specific amount of ## Methods -| Method | Description | -| --------------- | -------------------------------------------------------------- | -| `dismiss` | Dismiss the loading overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the loading did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the loading will dismiss. | -| `present` | Present the loading overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the loading overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the loading did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the loading will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the loading overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/menu-controller/readme.md b/core/src/components/menu-controller/readme.md index aacd78bb70..63a8f895f1 100644 --- a/core/src/components/menu-controller/readme.md +++ b/core/src/components/menu-controller/readme.md @@ -8,20 +8,192 @@ The MenuController makes it easy to control a Menu. Its methods can be used to d ## Methods -| Method | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `close` | Close the menu. If no menu is specified, then it will close any menu that is open. If a menu is specified, it will close that menu. | -| `enable` | Used to enable or disable a menu. For example, there could be multiple left menus, but only one of them should be able to be opened at the same time. If there are multiple menus on the same side, then enabling one menu will also automatically disable all the others that are on the same side. | -| `get` | Used to get a menu instance. If a menu is not provided then it will return the first menu found. If the specified menu is `left` or `right`, then it will return the enabled menu on that side. Otherwise, it will try to find the menu using the menu's `id` property. If a menu is not found then it will return `null`. | -| `getMenus` | Returns an array of all menu instances. | -| `getOpen` | Returns the instance of the menu already opened, otherwise `null`. | -| `isAnimating` | Returns true if any menu is currently animating. | -| `isEnabled` | Returns true if the specified menu is enabled. | -| `isOpen` | Returns true if the specified menu is open. If the menu is not specified, it will return true if any menu is currently open. | -| `open` | Open the menu. | -| `registerAnimation` | | -| `swipeGesture` | Used to enable or disable the ability to swipe open the menu. | -| `toggle` | Toggle the menu. If it's closed, it will open, and if opened, it will close. | +### `close(menuId?: string | null | undefined) => Promise` + +Close the menu. If no menu is specified, then it will close any menu +that is open. If a menu is specified, it will close that menu. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `enable(shouldEnable: boolean, menuId?: string | null | undefined) => Promise` + + + +### `get(menuId?: string | null | undefined) => Promise` + +Used to get a menu instance. If a menu is not provided then it will +return the first menu found. If the specified menu is `left` or `right`, then +it will return the enabled menu on that side. Otherwise, it will try to find +the menu using the menu's `id` property. If a menu is not found then it will +return `null`. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getMenus() => Promise` + +Returns an array of all menu instances. + +#### Returns + +Type: `Promise` + + + +### `getOpen() => Promise` + +Returns the instance of the menu already opened, otherwise `null`. + +#### Returns + +Type: `Promise` + + + +### `isAnimating() => Promise` + +Returns true if any menu is currently animating. + +#### Returns + +Type: `Promise` + + + +### `isEnabled(menuId?: string | null | undefined) => Promise` + +Returns true if the specified menu is enabled. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `isOpen(menuId?: string | null | undefined) => Promise` + +Returns true if the specified menu is open. If the menu is not specified, it +will return true if any menu is currently open. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `open(menuId?: string | null | undefined) => Promise` + +Open the menu. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `registerAnimation(name: string, animation: AnimationBuilder) => void` + + + +#### Parameters + +| Name | Type | Description | +| ----------- | ------------------ | ----------- | +| `name` | `string` | | +| `animation` | `AnimationBuilder` | | + +#### Returns + +Type: `void` + + + +### `swipeGesture(shouldEnable: boolean, menuId?: string | null | undefined) => Promise` + + + +### `toggle(menuId?: string | null | undefined) => Promise` + +Toggle the menu. If it's closed, it will open, and if opened, it +will close. + +#### Parameters + +| Name | Type | Description | +| -------- | --------------------------- | ----------- | +| `menuId` | `string | null | undefined` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/menu/readme.md b/core/src/components/menu/readme.md index 4c89bcc679..1f3a882a39 100644 --- a/core/src/components/menu/readme.md +++ b/core/src/components/menu/readme.md @@ -35,14 +35,90 @@ These can be controlled from the templates, or programmatically using the MenuCo ## Methods -| Method | Description | -| ---------- | ----------- | -| `close` | | -| `isActive` | | -| `isOpen` | | -| `open` | | -| `setOpen` | | -| `toggle` | | +### `close(animated?: boolean) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---------- | --------- | ----------- | +| `animated` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `isActive() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `isOpen() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `open(animated?: boolean) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---------- | --------- | ----------- | +| `animated` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `setOpen(shouldOpen: boolean, animated?: boolean) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ------------ | --------- | ----------- | +| `shouldOpen` | `boolean` | | +| `animated` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `toggle(animated?: boolean) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---------- | --------- | ----------- | +| `animated` | `boolean` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/modal-controller/readme.md b/core/src/components/modal-controller/readme.md index c3de38c3f1..da3d98f765 100644 --- a/core/src/components/modal-controller/readme.md +++ b/core/src/components/modal-controller/readme.md @@ -8,11 +8,49 @@ Modal controllers programmatically control the modal component. Modals can be cr ## Methods -| Method | Description | -| --------- | ------------------------------------------- | -| `create` | Create a modal overlay with modal options. | -| `dismiss` | Dismiss the open modal overlay. | -| `getTop` | Get the most recently opened modal overlay. | +### `create(opts: ModalOptions) => Promise` + +Create a modal overlay with modal options. + +#### Parameters + +| Name | Type | Description | +| ------ | ----------------- | ----------- | +| `opts` | `ModalOptions` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open modal overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened modal overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/modal/readme.md b/core/src/components/modal/readme.md index 7981001907..4b824fc2b7 100644 --- a/core/src/components/modal/readme.md +++ b/core/src/components/modal/readme.md @@ -44,12 +44,52 @@ Modals can be created using a [Modal Controller](../../modal-controller/ModalCon ## Methods -| Method | Description | -| --------------- | ------------------------------------------------------------ | -| `dismiss` | Dismiss the modal overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the modal did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the modal will dismiss. | -| `present` | Present the modal overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the modal overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the modal did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the modal will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the modal overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/nav/readme.md b/core/src/components/nav/readme.md index 37a3d6e1ad..7d4131d193 100644 --- a/core/src/components/nav/readme.md +++ b/core/src/components/nav/readme.md @@ -30,23 +30,257 @@ Unlike RouterOutlet, Nav is not tied to a particular router. Meaning that if we ## Methods -| Method | Description | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `canGoBack` | Returns true or false if the current view can go back | -| `getActive` | Gets the active view | -| `getByIndex` | Returns the view at the index | -| `getPrevious` | Gets the previous view | -| `getRouteId` | | -| `insert` | Inserts a component into the nav stack at the specified index. This is useful if you need to add a component at any point in your navigation stack. | -| `insertPages` | Inserts an array of components into the nav stack at the specified index. The last component in the array will become instantiated as a view, and animate in to become the active view. | -| `pop` | Call to navigate back from a current component. Similar to push(), you can also pass navigation options. | -| `popTo` | Pop to a specific index in the navigation stack | -| `popToRoot` | Navigate back to the root of the stack, no matter how far back that is. | -| `push` | Push a new component onto the current navigation stack. Pass any additional information along as an object. This additional information is accessible through NavParams | -| `removeIndex` | Removes a page from the nav stack at the specified index. | -| `setPages` | Set the views of the current navigation stack and navigate to the last view. By default animations are disabled, but they can be enabled by passing options to the navigation controller.You can also pass any navigation params to the individual pages in the array. | -| `setRoot` | Set the root for the current navigation stack. | -| `setRouteId` | | +### `canGoBack(view?: ViewController | undefined) => Promise` + +Returns true or false if the current view can go back + +#### Parameters + +| Name | Type | Description | +| ------ | ---------------------------- | ----------- | +| `view` | `ViewController | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getActive() => Promise` + +Gets the active view + +#### Returns + +Type: `Promise` + + + +### `getByIndex(index: number) => Promise` + +Returns the view at the index + +#### Parameters + +| Name | Type | Description | +| ------- | -------- | ----------- | +| `index` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `getPrevious(view?: ViewController | undefined) => Promise` + +Gets the previous view + +#### Parameters + +| Name | Type | Description | +| ------ | ---------------------------- | ----------- | +| `view` | `ViewController | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getRouteId() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `insert(insertIndex: number, component: T, componentProps?: ComponentProps | ...` + +Inserts a component into the nav stack at the specified index. This is useful if you need to add a component at any point in your navigation stack. + +#### Parameters + +| Name | Type | Description | +| ---------------- | -------------------------------------- | ----------- | +| `insertIndex` | `number` | | +| `component` | `T` | | +| `componentProps` | `ComponentProps | null | undefined` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `insertPages(insertIndex: number, insertComponents: NavComponent[], opts?: NavOptions | null | undefined, don...` + +Inserts an array of components into the nav stack at the specified index. The last component in the array will become instantiated as a view, and animate in to become the active view. + +#### Parameters + +| Name | Type | Description | +| ------------------ | ------------------------------- | ----------- | +| `insertIndex` | `number` | | +| `insertComponents` | `NavComponent[]` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `pop(opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise` + +Call to navigate back from a current component. Similar to push(), you can also pass navigation options. + +#### Parameters + +| Name | Type | Description | +| ------ | ------------------------------- | ----------- | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `popTo(indexOrViewCtrl: number | ViewController, opts?: NavOptions | null | undefined, done?: Transitio...` + +Pop to a specific index in the navigation stack + +#### Parameters + +| Name | Type | Description | +| ----------------- | ------------------------------- | ----------- | +| `indexOrViewCtrl` | `number | ViewController` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `popToRoot(opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise` + +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` | | + +#### Returns + +Type: `Promise` + + + +### `push(component: T, componentProps?: ComponentProps | null | undefined, opt...` + +Push a new component onto the current navigation stack. Pass any additional information along as an object. This additional information is accessible through NavParams + +#### Parameters + +| Name | Type | Description | +| ---------------- | -------------------------------------- | ----------- | +| `component` | `T` | | +| `componentProps` | `ComponentProps | null | undefined` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `removeIndex(startIndex: number, removeCount?: number, opts?: NavOptions | null | undefined, done?: Transitio...` + +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` | | + +#### Returns + +Type: `Promise` + + + +### `setPages(views: any[], opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Prom...` + +Set the views of the current navigation stack and navigate to the last view. By default animations are disabled, but they can be enabled by passing options to the navigation controller.You can also pass any navigation params to the individual pages in the array. + +#### Parameters + +| Name | Type | Description | +| ------- | ------------------------------- | ----------- | +| `views` | `any[]` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `setRoot(component: T, componentProps?: ComponentProps | null | undefined, opt...` + +Set the root for the current navigation stack. + +#### Parameters + +| Name | Type | Description | +| ---------------- | -------------------------------------- | ----------- | +| `component` | `T` | | +| `componentProps` | `ComponentProps | null | undefined` | | +| `opts` | `NavOptions | null | undefined` | | +| `done` | `TransitionDoneFn | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `setRouteId(id: string, params: { [key: string]: any; } | undefined, direction: number) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ----------- | ------------------------------------- | ----------- | +| `id` | `string` | | +| `params` | `{ [key: string]: any; } | undefined` | | +| `direction` | `number` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/picker-controller/readme.md b/core/src/components/picker-controller/readme.md index 2a8aab31f0..8d9f336979 100644 --- a/core/src/components/picker-controller/readme.md +++ b/core/src/components/picker-controller/readme.md @@ -7,11 +7,49 @@ ## Methods -| Method | Description | -| --------- | ----------- | -| `create` | | -| `dismiss` | | -| `getTop` | | +### `create(opts: PickerOptions) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ------ | --------------- | ----------- | +| `opts` | `PickerOptions` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + + + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/picker/readme.md b/core/src/components/picker/readme.md index 06e07fd572..8ce9ab6d9d 100644 --- a/core/src/components/picker/readme.md +++ b/core/src/components/picker/readme.md @@ -39,13 +39,68 @@ A Picker is a dialog that displays a row of buttons and columns underneath. It a ## Methods -| Method | Description | -| --------------- | ------------------------------------------------------------- | -| `dismiss` | Dismiss the picker overlay after it has been presented. | -| `getColumn` | Returns the column the matches the specified name | -| `onDidDismiss` | Returns a promise that resolves when the picker did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the picker will dismiss. | -| `present` | Present the picker overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the picker overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getColumn(name: string) => Promise` + +Returns the column the matches the specified name + +#### Parameters + +| Name | Type | Description | +| ------ | -------- | ----------- | +| `name` | `string` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the picker did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the picker will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the picker overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/popover-controller/readme.md b/core/src/components/popover-controller/readme.md index 3d07afe4c6..b9552947e6 100644 --- a/core/src/components/popover-controller/readme.md +++ b/core/src/components/popover-controller/readme.md @@ -8,11 +8,49 @@ Popover controllers programmatically control the popover component. Popovers can ## Methods -| Method | Description | -| --------- | ---------------------------------------------- | -| `create` | Create a popover overlay with popover options. | -| `dismiss` | Dismiss the open popover overlay. | -| `getTop` | Get the most recently opened popover overlay. | +### `create(opts: PopoverOptions) => Promise` + +Create a popover overlay with popover options. + +#### Parameters + +| Name | Type | Description | +| ------ | ------------------- | ----------- | +| `opts` | `PopoverOptions` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open popover overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened popover overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/popover/readme.md b/core/src/components/popover/readme.md index d27ebdacec..005df066ee 100644 --- a/core/src/components/popover/readme.md +++ b/core/src/components/popover/readme.md @@ -48,12 +48,52 @@ To present a popover, call the `present` method on a popover instance. In order ## Methods -| Method | Description | -| --------------- | -------------------------------------------------------------- | -| `dismiss` | Dismiss the popover overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the popover did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the popover will dismiss. | -| `present` | Present the popover overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the popover overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the popover did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the popover will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the popover overlay after it has been created. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/refresher/readme.md b/core/src/components/refresher/readme.md index c030493509..a4029856fd 100644 --- a/core/src/components/refresher/readme.md +++ b/core/src/components/refresher/readme.md @@ -35,11 +35,47 @@ refresher. ## Methods -| Method | Description | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cancel` | Changes the refresher's state from `refreshing` to `cancelling`. | -| `complete` | Call `complete()` when your async operation has completed. For example, the `refreshing` state is while the app is performing an asynchronous operation, such as receiving more data from an AJAX request. Once the data has been received, you then call this method to signify that the refreshing has completed and to close the refresher. This method also changes the refresher's state from `refreshing` to `completing`. | -| `getProgress` | A number representing how far down the user has pulled. The number `0` represents the user hasn't pulled down at all. The number `1`, and anything greater than `1`, represents that the user has pulled far enough down that when they let go then the refresh will happen. If they let go and the number is less than `1`, then the refresh will not happen, and the content will return to it's original position. | +### `cancel() => void` + +Changes the refresher's state from `refreshing` to `cancelling`. + +#### Returns + +Type: `void` + + + +### `complete() => void` + +Call `complete()` when your async operation has completed. +For example, the `refreshing` state is while the app is performing +an asynchronous operation, such as receiving more data from an +AJAX request. Once the data has been received, you then call this +method to signify that the refreshing has completed and to close +the refresher. This method also changes the refresher's state from +`refreshing` to `completing`. + +#### Returns + +Type: `void` + + + +### `getProgress() => Promise` + +A number representing how far down the user has pulled. +The number `0` represents the user hasn't pulled down at all. The +number `1`, and anything greater than `1`, represents that the user +has pulled far enough down that when they let go then the refresh will +happen. If they let go and the number is less than `1`, then the +refresh will not happen, and the content will return to it's original +position. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/reorder-group/readme.md b/core/src/components/reorder-group/readme.md index 3a5364729c..f06f7db596 100644 --- a/core/src/components/reorder-group/readme.md +++ b/core/src/components/reorder-group/readme.md @@ -65,9 +65,21 @@ This utility is really handy when ## Methods -| Method | Description | -| ---------- | ----------- | -| `complete` | | +### `complete(listOrReorder?: boolean | any[] | undefined) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| --------------- | ----------------------------- | ----------- | +| `listOrReorder` | `boolean | any[] | undefined` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/ripple-effect/readme.md b/core/src/components/ripple-effect/readme.md index 05d888474a..adffbb0a3d 100644 --- a/core/src/components/ripple-effect/readme.md +++ b/core/src/components/ripple-effect/readme.md @@ -8,9 +8,22 @@ The ripple effect component adds the [Material Design ink ripple interaction eff ## Methods -| Method | Description | -| ----------- | -------------------------------------------- | -| `addRipple` | Adds the ripple effect to the parent element | +### `addRipple(pageX: number, pageY: number) => void` + +Adds the ripple effect to the parent element + +#### Parameters + +| Name | Type | Description | +| ------- | -------- | ----------- | +| `pageX` | `number` | | +| `pageY` | `number` | | + +#### Returns + +Type: `void` + + ---------------------------------------------- diff --git a/core/src/components/router-outlet/readme.md b/core/src/components/router-outlet/readme.md index a6d5a4420b..a419b91c18 100644 --- a/core/src/components/router-outlet/readme.md +++ b/core/src/components/router-outlet/readme.md @@ -31,12 +31,69 @@ While RouterOutlet has methods for navigating around, it's recommended to use th ## Methods -| Method | Description | -| ------------ | ----------------------------------------------------- | -| `commit` | | -| `getRouteId` | Returns the ID for the current route | -| `setRoot` | Set the root component for the given navigation stack | -| `setRouteId` | | +### `commit(enteringEl: HTMLElement, leavingEl: HTMLElement | undefined, opts?: RouterOutletOptions | undefi...` + + + +#### Parameters + +| Name | Type | Description | +| ------------ | --------------------------------- | ----------- | +| `enteringEl` | `HTMLElement` | | +| `leavingEl` | `HTMLElement | undefined` | | +| `opts` | `RouterOutletOptions | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getRouteId() => Promise` + +Returns the ID for the current route + +#### Returns + +Type: `Promise` + + + +### `setRoot(component: ComponentRef, params?: { [key: string]: any; } | undefined, opts?: RouterOutletOption...` + +Set the root component for the given navigation stack + +#### Parameters + +| Name | Type | Description | +| ----------- | ------------------------------------- | ----------- | +| `component` | `ComponentRef` | | +| `params` | `{ [key: string]: any; } | undefined` | | +| `opts` | `RouterOutletOptions | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `setRouteId(id: string, params: { [key: string]: any; } | undefined, direction: number) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ----------- | ------------------------------------- | ----------- | +| `id` | `string` | | +| `params` | `{ [key: string]: any; } | undefined` | | +| `direction` | `number` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/router/readme.md b/core/src/components/router/readme.md index 830a0a3787..8789af3c11 100644 --- a/core/src/components/router/readme.md +++ b/core/src/components/router/readme.md @@ -36,12 +36,58 @@ If you're using Angular, please see [ion-router-outlet](../router-outlet) instea ## Methods -| Method | Description | -| ------------ | ----------------------------- | -| `goBack` | | -| `navChanged` | | -| `printDebug` | | -| `push` | Navigate to the specified URL | +### `goBack() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `navChanged(intent: number) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| -------- | -------- | ----------- | +| `intent` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `printDebug() => void` + + + +#### Returns + +Type: `void` + + + +### `push(url: string, direction?: RouterDirection) => Promise` + +Navigate to the specified URL + +#### Parameters + +| Name | Type | Description | +| ----------- | ----------------- | ----------- | +| `url` | `string` | | +| `direction` | `RouterDirection` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/searchbar/readme.md b/core/src/components/searchbar/readme.md index 83fa362bb2..9ccb193f66 100644 --- a/core/src/components/searchbar/readme.md +++ b/core/src/components/searchbar/readme.md @@ -44,9 +44,15 @@ A Searchbar should be used instead of an input to search lists. A clear button i ## Methods -| Method | Description | -| ---------- | ----------- | -| `setFocus` | | +### `setFocus() => void` + + + +#### Returns + +Type: `void` + + ## CSS Custom Properties diff --git a/core/src/components/select/readme.md b/core/src/components/select/readme.md index d8ac6a5f8a..024c2fc8d1 100644 --- a/core/src/components/select/readme.md +++ b/core/src/components/select/readme.md @@ -69,9 +69,21 @@ Since select uses the alert, action sheet and popover interfaces, options can be ## Methods -| Method | Description | -| ------ | ----------- | -| `open` | | +### `open(ev?: UIEvent | undefined) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---- | --------------------- | ----------- | +| `ev` | `UIEvent | undefined` | | + +#### Returns + +Type: `Promise` + + ## CSS Custom Properties diff --git a/core/src/components/slides/readme.md b/core/src/components/slides/readme.md index 6512a94484..84586392ee 100644 --- a/core/src/components/slides/readme.md +++ b/core/src/components/slides/readme.md @@ -53,22 +53,186 @@ Licensed under MIT ## Methods -| Method | Description | -| ------------------ | ----------------------------------------------------------------------------------------------- | -| `getActiveIndex` | Get the index of the active slide. | -| `getPreviousIndex` | Get the index of the previous slide. | -| `isBeginning` | Get whether or not the current slide is the first slide. | -| `isEnd` | Get whether or not the current slide is the last slide. | -| `length` | Get the total number of slides. | -| `lockSwipeToNext` | Lock or unlock the ability to slide to the next slides. | -| `lockSwipeToPrev` | Lock or unlock the ability to slide to the previous slides. | -| `lockSwipes` | Lock or unlock the ability to slide to change slides. | -| `slideNext` | Transition to the next slide. | -| `slidePrev` | Transition to the previous slide. | -| `slideTo` | Transition to the specified slide. | -| `startAutoplay` | Start auto play. | -| `stopAutoplay` | Stop auto play. | -| `update` | Update the underlying slider implementation. Call this if you've added or removed child slides. | +### `getActiveIndex() => Promise` + +Get the index of the active slide. + +#### Returns + +Type: `Promise` + + + +### `getPreviousIndex() => Promise` + +Get the index of the previous slide. + +#### Returns + +Type: `Promise` + + + +### `isBeginning() => Promise` + +Get whether or not the current slide is the first slide. + +#### Returns + +Type: `Promise` + + + +### `isEnd() => Promise` + +Get whether or not the current slide is the last slide. + +#### Returns + +Type: `Promise` + + + +### `length() => Promise` + +Get the total number of slides. + +#### Returns + +Type: `Promise` + + + +### `lockSwipeToNext(shouldLockSwipeToNext: boolean) => Promise` + +Lock or unlock the ability to slide to the next slides. + +#### Parameters + +| Name | Type | Description | +| ----------------------- | --------- | ----------- | +| `shouldLockSwipeToNext` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `lockSwipeToPrev(shouldLockSwipeToPrev: boolean) => Promise` + +Lock or unlock the ability to slide to the previous slides. + +#### Parameters + +| Name | Type | Description | +| ----------------------- | --------- | ----------- | +| `shouldLockSwipeToPrev` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `lockSwipes(shouldLockSwipes: boolean) => Promise` + +Lock or unlock the ability to slide to change slides. + +#### Parameters + +| Name | Type | Description | +| ------------------ | --------- | ----------- | +| `shouldLockSwipes` | `boolean` | | + +#### Returns + +Type: `Promise` + + + +### `slideNext(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise` + +Transition to the next slide. + +#### Parameters + +| Name | Type | Description | +| -------------- | --------------------- | ----------- | +| `speed` | `number | undefined` | | +| `runCallbacks` | `boolean | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `slidePrev(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise` + +Transition to the previous slide. + +#### Parameters + +| Name | Type | Description | +| -------------- | --------------------- | ----------- | +| `speed` | `number | undefined` | | +| `runCallbacks` | `boolean | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `slideTo(index: number, speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise` + +Transition to the specified slide. + +#### Parameters + +| Name | Type | Description | +| -------------- | --------------------- | ----------- | +| `index` | `number` | | +| `speed` | `number | undefined` | | +| `runCallbacks` | `boolean | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `startAutoplay() => Promise` + +Start auto play. + +#### Returns + +Type: `Promise` + + + +### `stopAutoplay() => Promise` + +Stop auto play. + +#### Returns + +Type: `Promise` + + + +### `update() => Promise` + +Update the underlying slider implementation. Call this if you've added or removed +child slides. + +#### Returns + +Type: `Promise` + + ## CSS Custom Properties diff --git a/core/src/components/tab/readme.md b/core/src/components/tab/readme.md index 8f9bcbccfc..7d5017db56 100644 --- a/core/src/components/tab/readme.md +++ b/core/src/components/tab/readme.md @@ -40,9 +40,15 @@ See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs. ## Methods -| Method | Description | -| ----------- | ------------------------------------ | -| `setActive` | Set the active component for the tab | +### `setActive() => Promise` + +Set the active component for the tab + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/tabs/readme.md b/core/src/components/tabs/readme.md index 4b6a53e5ab..dfa21b1cb8 100644 --- a/core/src/components/tabs/readme.md +++ b/core/src/components/tabs/readme.md @@ -34,13 +34,73 @@ The component is a container of individual [Tab](../Tab/) components. ## Methods -| Method | Description | -| ------------- | ------------------------------------------------ | -| `getRouteId` | | -| `getSelected` | Get the currently selected tab | -| `getTab` | Get the tab at the given index | -| `select` | Index or the Tab instance, of the tab to select. | -| `setRouteId` | | +### `getRouteId() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `getSelected() => Promise` + +Get the currently selected tab + +#### Returns + +Type: `Promise` + + + +### `getTab(tabOrIndex: string | number | HTMLIonTabElement) => Promise` + +Get the tab at the given index + +#### Parameters + +| Name | Type | Description | +| ------------ | ------------------------------------- | ----------- | +| `tabOrIndex` | `string | number | HTMLIonTabElement` | | + +#### Returns + +Type: `Promise` + + + +### `select(tabOrIndex: number | HTMLIonTabElement) => Promise` + +Index or the Tab instance, of the tab to select. + +#### Parameters + +| Name | Type | Description | +| ------------ | ---------------------------- | ----------- | +| `tabOrIndex` | `number | HTMLIonTabElement` | | + +#### Returns + +Type: `Promise` + + + +### `setRouteId(id: string) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---- | -------- | ----------- | +| `id` | `string` | | + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/textarea/readme.md b/core/src/components/textarea/readme.md index 53bdd58a75..87b6f2e898 100644 --- a/core/src/components/textarea/readme.md +++ b/core/src/components/textarea/readme.md @@ -48,9 +48,15 @@ The textarea component accepts the [native textarea attributes](https://develope ## Methods -| Method | Description | -| ---------- | ----------- | -| `setFocus` | | +### `setFocus() => void` + + + +#### Returns + +Type: `void` + + ## CSS Custom Properties diff --git a/core/src/components/toast-controller/readme.md b/core/src/components/toast-controller/readme.md index aa6dc9c88f..d01de5baf8 100644 --- a/core/src/components/toast-controller/readme.md +++ b/core/src/components/toast-controller/readme.md @@ -8,11 +8,49 @@ ToastController is a component use to create Toast components. Please see the do ## Methods -| Method | Description | -| --------- | ------------------------------------------- | -| `create` | Create a toast overlay with toast options. | -| `dismiss` | Dismiss the open toast overlay. | -| `getTop` | Get the most recently opened toast overlay. | +### `create(opts?: ToastOptions | undefined) => Promise` + +Create a toast overlay with toast options. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------------- | ----------- | +| `opts` | `ToastOptions | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise` + +Dismiss the open toast overlay. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | +| `id` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `getTop() => Promise` + +Get the most recently opened toast overlay. + +#### Returns + +Type: `Promise` + + ---------------------------------------------- diff --git a/core/src/components/toast/readme.md b/core/src/components/toast/readme.md index c128f09491..9c926547e2 100644 --- a/core/src/components/toast/readme.md +++ b/core/src/components/toast/readme.md @@ -51,12 +51,52 @@ The toast can be dismissed automatically after a specific amount of time by pass ## Methods -| Method | Description | -| --------------- | ------------------------------------------------------------ | -| `dismiss` | Dismiss the toast overlay after it has been presented. | -| `onDidDismiss` | Returns a promise that resolves when the toast did dismiss. | -| `onWillDismiss` | Returns a promise that resolves when the toast will dismiss. | -| `present` | Present the toast overlay after it has been created. | +### `dismiss(data?: any, role?: string | undefined) => Promise` + +Dismiss the toast overlay after it has been presented. + +#### Parameters + +| Name | Type | Description | +| ------ | -------------------- | ----------- | +| `data` | `any` | | +| `role` | `string | undefined` | | + +#### Returns + +Type: `Promise` + + + +### `onDidDismiss() => Promise>` + +Returns a promise that resolves when the toast did dismiss. + +#### Returns + +Type: `Promise>` + + + +### `onWillDismiss() => Promise>` + +Returns a promise that resolves when the toast will dismiss. + +#### Returns + +Type: `Promise>` + + + +### `present() => Promise` + +Present the toast overlay after it has been created. + +#### Returns + +Type: `Promise` + + ## CSS Custom Properties diff --git a/core/src/components/virtual-scroll/readme.md b/core/src/components/virtual-scroll/readme.md index 8e93037fbb..9e723f6e29 100644 --- a/core/src/components/virtual-scroll/readme.md +++ b/core/src/components/virtual-scroll/readme.md @@ -201,11 +201,48 @@ dataset, so please make sure they're performant. ## Methods -| Method | Description | -| ----------------- | ----------- | -| `markDirty` | | -| `markDirtyTail` | | -| `positionForItem` | | +### `markDirty(offset: number, len?: number) => void` + + + +#### Parameters + +| Name | Type | Description | +| -------- | -------- | ----------- | +| `offset` | `number` | | +| `len` | `number` | | + +#### Returns + +Type: `void` + + + +### `markDirtyTail() => void` + + + +#### Returns + +Type: `void` + + + +### `positionForItem(index: number) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ------- | -------- | ----------- | +| `index` | `number` | | + +#### Returns + +Type: `Promise` + + ----------------------------------------------