diff --git a/docs/en-US/component/alert.md b/docs/en-US/component/alert.md index 1bb312e0b9..4b26fe8364 100644 --- a/docs/en-US/component/alert.md +++ b/docs/en-US/component/alert.md @@ -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. | | `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. | | `'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. | | +| 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. |