Skip to content

Commit

Permalink
fix formatting and inconsistent backticks (#790)
Browse files Browse the repository at this point in the history
  • Loading branch information
celluj34 committed May 27, 2021
1 parent 42e77c0 commit 49a9164
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions components/modal/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Properties | Descrition | Type | Default

Properties | Descrition | Type | Default
-----------|------------|------|--------
----|-----|------|------
| `[title]` | Title | `string \| TemplateRef` | - |
| `[message]` | Message | `string \| TemplateRef` | - |
| `[actions]` | Button group | `Array<text: string, onPress: Function, style: object>` | - |
Expand All @@ -53,7 +52,7 @@ Properties | Descrition | Type | Default
| `[placeholders]` | placeholders | `string[]` | - |
| `[platform]` | Set the special style depends on platform, works on web only | `'android' \| 'ios'` | `'ios'`|

call ModalService.prompt(title, message, callbackOrActions, type?, defaultValue?, placeholders?).close()` can close prompt Modal outside anywhere as you wish.
call `ModalService.prompt(title, message, callbackOrActions, type?, defaultValue?, placeholders?).close()` can close prompt Modal outside anywhere as you wish.

### ModalService.operation(actions?) ( Support Platform:WEB )

Expand All @@ -62,8 +61,7 @@ Properties | Descrition | Type | Default
| `[actions]` | button group | `Array<text: string, onPress: Function, style: object>` | - |
| `[platform]` | Set the special style depends on platform, works on web only | `'android' \| 'ios'` | `'ios'`|

call ModalService.operation(actions?).close()` can close Operation Modal outside anywhere as you wish.

call `ModalService.operation(actions?).close()` can close Operation Modal outside anywhere as you wish.

```ts
constructor(modal: ModalService) {
Expand All @@ -76,22 +74,22 @@ constructor(modal: ModalService) {

#### Other Methods/Attributes for ModalService

| Methods/Attributes | Description | Type |
|----|----|
Methods/Attributes | Description | Type
-------------------|-------------|-----
| `openModals` | All currently open Modal list | `ModalRef[]` |
| `afterAllClose` | Callback called after all Modals closed completely | `Observable&lt;void&gt;` |
| `afterAllClose` | Callback called after all Modals closed completely | `Observable<void>` |
| `closeAll()` | Close all modals | `Function` |

#### ModalRef

> ModalRef object is used to control dialogs and communicate with inside content
The dialog created by the service method `ModalService.xxx()` will return a `ModalRef` object that is used to manipulate the dialog , This object has the following methods:
The dialog created by the service method `ModalService.xxx()` will return a `ModalRef` object that is used to manipulate the dialog, This object has the following methods:

| Method | Description |
|----|----|
| `afterOpen` | Same as AfterOpen but of type Observable&lt;void&gt; |
| `afterClose` | Same as AfterClose, but of type Observable&lt;result:any&gt; |
Method | Description
-------|------------
| `afterOpen` | Same as AfterOpen but of type `Observable<void>` |
| `afterClose` | Same as AfterClose, but of type `Observable<result:any>` |
| `close(result: any) => void` | Close (hide) the dialog. <i>Note: When used for a dialog created as a service, this method will destroy the dialog directly (as with the destroy method)</i> |
| `destroy(result: any) => void` | Destroy the dialog. <i>Note: Used only for dialogs created by the service (non-service created dialogs, this method only hides the dialog)</i> |
| `getContentComponent() => Component` | Gets the Component instance in the contents of the dialog for `Content`. <i> Note: When the dialog is not initialized (`ngOnInit` is not executed), this function will return `undefined`</i> |
Expand Down

0 comments on commit 49a9164

Please sign in to comment.