mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
chore(): update readme
This commit is contained in:
@@ -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<HTMLIonLoadingElement>`
|
||||
|
||||
Create a loading overlay with loading options.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | ---------------------------- | ----------- |
|
||||
| `opts` | `LoadingOptions | undefined` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
Type: `Promise<HTMLIonLoadingElement>`
|
||||
|
||||
|
||||
|
||||
### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>`
|
||||
|
||||
Dismiss the open loading overlay.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------ | -------------------- | ----------- |
|
||||
| `data` | `any` | |
|
||||
| `role` | `string | undefined` | |
|
||||
| `id` | `string | undefined` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
Type: `Promise<boolean>`
|
||||
|
||||
|
||||
|
||||
### `getTop() => Promise<HTMLIonLoadingElement | undefined>`
|
||||
|
||||
Get the most recently opened loading overlay.
|
||||
|
||||
#### Returns
|
||||
|
||||
Type: `Promise<HTMLIonLoadingElement | undefined>`
|
||||
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user