chore(): update readme

This commit is contained in:
Manu Mtz.-Almeida
2018-10-08 15:44:51 -05:00
parent b4a73ad760
commit 4036db5480
42 changed files with 1966 additions and 215 deletions

View File

@@ -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<T extends ComponentRef>(opts: ModalOptions<T>) => Promise<HTMLIonModalElement>`
Create a modal overlay with modal options.
#### Parameters
| Name | Type | Description |
| ------ | ----------------- | ----------- |
| `opts` | `ModalOptions<T>` | |
#### Returns
Type: `Promise<HTMLIonModalElement>`
### `dismiss(data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>`
Dismiss the open modal overlay.
#### Parameters
| Name | Type | Description |
| ------ | -------------------- | ----------- |
| `data` | `any` | |
| `role` | `string | undefined` | |
| `id` | `string | undefined` | |
#### Returns
Type: `Promise<boolean>`
### `getTop() => Promise<HTMLIonModalElement | undefined>`
Get the most recently opened modal overlay.
#### Returns
Type: `Promise<HTMLIonModalElement | undefined>`
----------------------------------------------