javascript/element-plus
1
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2026-03-13 07:51:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): [alert] (#10460)

Browse Source 
* Replace jsx like tags in markdown table.

Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com>
This commit is contained in:
Jeremy
2022-11-06 12:17:54 +08:00
committed by GitHub
parent 1688a6e077
commit 5221e3eb5d
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/en-US/component/alert.md
View File

@@ -77,28 +77,28 @@ alert/icon-description
## Alert API
### Alert Attributes
### Attributes
| Name | Description | Type | Default | Required |
| ------------- | ---------------------------------------- | -------------------------------------------------------------- | --------- | -------- |
| `title` | alert title. | `string` | — | No |
| `type` | alert type. | <EnumType :values="['success', 'warning', 'info', 'error']" /> | `info` | No |
| `description` | descriptive text. | `string` | — | No |
| `closable` | whether alert can be dismissed. | `boolean` | `true` | No |
| `center` | whether content is placed in the center. | `boolean` | `false` | No |
| `close-text` | customized close button text. | `string` | — | No |
| `show-icon` | whether a type icon is displayed. | `boolean` | `false` | No |
| `effect` | theme style. | <EnumType :values="['light', 'dark']" /> | `'light'` | No |
| Name | Description | Type | Default | Required |
| ----------- | ---------------------------------------- | ----------------------------------------------------- | --------- | -------- |
| title | alert title. | ^[string] | — | No |
| type | alert type. | ^[enum]`'success' \| 'warning' \| 'info' \| 'error' ` | `info` | No |
| description | descriptive text. | ^[string] | — | No |
| closable | whether alert can be dismissed. | ^[boolean] | `true` | No |
| center | whether content is placed in the center. | ^[boolean] | `false` | No |
| close-text | customized close button text. | ^[string] | — | No |
| show-icon | whether a type icon is displayed. | ^[boolean] | `false` | No |
| effect | theme style. | ^[enum]`'light' \| 'dark'` | `'light'` | No |
### Alert Events
### Events
| Name | Description | Type |
| ------- | ----------------------------- | -------------------------------------------------- |
| `close` | trigger when alert is closed. | <FunctionType :params="[['evt', 'MouseEvent']]" /> |
| Name | Description | Type |
| ----- | ----------------------------- | ---------------------------------------- |
| close | trigger when alert is closed. | ^[Function]`(event: MouseEvent) => void` |
### Alert Slots
### Slots
| Name | Description |
| --------- | --------------------------------- |
| `default` | content of the alert description. |
| `title` | content of the alert title. |
| Name | Description |
| ------- | --------------------------------- |
| default | content of the alert description. |
| title | content of the alert title. |