Alert
Displays important alert messages.
Basic Usage
Alert components are non-overlay elements in the page that does not disappear automatically.
Alert provides 5 types of themes defined by type, whose default value is info. primary has been added in 2.9.11.
Theme
Alert provide two different themes, light and dark.
Set effect to change theme, default is light.
Customizable Close Button
Customize the close button as texts or other symbols.
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.
With Icon
Displaying an icon improves readability.
Setting the show-icon attribute displays an icon that corresponds with the current Alert type. Or use the icon slot to customize icon.
Centered Text
Use the center attribute to center the text.
With Description
Description includes a message with more detailed information.
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.
With Icon and Description
At last, this is an example with both icon and description.
More text description
More text description
More text description
More text description
More text description
With Delayed Attributes 2.10.0
At last, this is an example with delayed attributes.
Alert API
Attributes
| Name | Description | Type | Default |
|---|---|---|---|
| title | alert title. | string | — |
| type | alert type. | enum | info |
| description | descriptive text. | string | — |
| closable | whether alert can be dismissed. | boolean | true |
| center | whether content is placed in the center. | boolean | false |
| close-text | customized close button text. | string | — |
| show-icon | whether a type icon is displayed. | boolean | false |
| effect | theme style. | enum | light |
| show-after 2.10.0 | delay of appearance, in millisecond | number | 0 |
| hide-after 2.10.0 | delay of disappear, in millisecond | number | 200 |
| auto-close 2.10.0 | timeout in milliseconds to hide alert | number | 0 |
Events
| Name | Description | Type |
|---|---|---|
| open 2.10.0 | trigger when alert is opened. | Function |
| close | trigger when alert is closed. | Function |
Slots
| Name | Description |
|---|---|
| default | content of the alert description. |
| title | content of the alert title. |
| icon 2.9.7 | content of the alert icon. |