2021-10-22 19:32:39 +08:00
---
lang: en-US
2021-10-25 13:57:18 +08:00
type: component
2021-10-22 19:32:39 +08:00
---
2021-09-17 00:18:50 +08:00
# Alert
2020-08-13 15:18:26 +08:00
Displays important alert messages.
2021-09-17 00:18:50 +08:00
## Basic usage
2020-08-13 15:18:26 +08:00
Alert components are non-overlay elements in the page that does not disappear automatically.
:::demo Alert provides 4 types of themes defined by `type` , whose default value is `info` .
2021-09-17 00:18:50 +08:00
alert/basic
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## Theme
2020-08-13 15:18:26 +08:00
Alert provide two different themes, `light` and `dark` .
:::demo Set `effect` to change theme, default is `light` .
2021-09-04 19:29:28 +08:00
2021-09-17 00:18:50 +08:00
alert/theme
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## Customizable close button
2020-08-13 15:18:26 +08:00
Customize the close button as texts or other symbols.
:::demo Alert allows you to configure if it's closable. The close button text and closing callbacks are also customizable. `closable` attribute decides if the component can be closed or not. It accepts `boolean` , and the default is `true` . You can set `close-text` attribute to replace the default cross symbol as the close button. Be careful that `close-text` must be a string. `close` event fires when the component is closed.
2021-09-17 00:18:50 +08:00
alert/close-button
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## With icon
2020-08-13 15:18:26 +08:00
Displaying an icon improves readability.
:::demo Setting the `show-icon` attribute displays an icon that corresponds with the current Alert type.
2021-09-17 00:18:50 +08:00
alert/icon
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
## Centered text
Use the `center` attribute to center the text.
:::demo
2021-09-17 00:18:50 +08:00
alert/center
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## With description
2020-08-13 15:18:26 +08:00
Description includes a message with more detailed information.
:::demo Besides the required `title` attribute, you can add a `description` attribute to help you describe the alert with more details. Description can only store text string, and it will word wrap automatically.
2021-09-17 00:18:50 +08:00
alert/description
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## With icon and description
2020-08-13 15:18:26 +08:00
:::demo At last, this is an example with both icon and description.
2021-09-17 00:18:50 +08:00
alert/icon-description
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## Attributes
2021-09-04 19:29:28 +08:00
| Attribute | Description | Type | Accepted Values | Default |
| ----------- | ---------------------------------------------------------- | ------- | -------------------------- | ------- |
| title | title | string | — | — |
| type | Component type | string | success/warning/info/error | info |
| description | Descriptive text. Can also be passed with the default slot | string | — | — |
| closable | If closable or not | boolean | — | true |
| center | Whether to center the text | boolean | — | false |
| close-text | Customized close button text | string | — | — |
| show-icon | If a type icon is displayed | boolean | — | false |
| effect | Choose theme | string | light/dark | light |
2020-08-13 15:18:26 +08:00
2021-09-17 00:18:50 +08:00
## Slots
2020-08-13 15:18:26 +08:00
2021-09-04 19:29:28 +08:00
| Name | Description |
| ----- | -------------------------- |
| — | description |
2020-08-13 15:18:26 +08:00
| title | content of the Alert title |
2021-09-17 00:18:50 +08:00
## Events
2021-09-04 19:29:28 +08:00
| Event Name | Description | Parameters |
| ---------- | -------------------------- | ---------- |
| close | fires when alert is closed | — |
2021-09-17 00:18:50 +08:00
< style lang = "scss" >
.example-showcase {
.el-alert {
margin: 20px 0 0;
& :first-child {
margin: 0
}
}
}
< / style >
