mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-15 09:50:58 +08:00
7fe4e0b026
* feat(components): [el-message] & [el-notification] appendTo option added * fix(components): unit test and replaced warn with debugWarn
100 lines
5.0 KiB
Markdown
100 lines
5.0 KiB
Markdown
---
|
|
title: Message
|
|
lang: en-US
|
|
---
|
|
|
|
# Message
|
|
|
|
Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification.
|
|
|
|
## Basic usage
|
|
|
|
Displays at the top, and disappears after 3 seconds.
|
|
|
|
:::demo The setup of Message is very similar to notification, so parts of the options won't be explained in detail here. You can check the options table below combined with notification doc to understand it. Element Plus has registered a `$message` method for invoking. Message can take a string or a VNode as parameter, and it will be shown as the main body.
|
|
|
|
message/basic
|
|
|
|
:::
|
|
|
|
## Types
|
|
|
|
Used to show the feedback of Success, Warning, Message and Error activities.
|
|
|
|
:::demo When you need more customizations, Message component can also take an object as parameter. For example, setting value of `type` can define different types, and its default is `info`. In such cases the main body is passed in as the value of `message`. Also, we have registered methods for different types, so you can directly call it without passing a type like `open4`.
|
|
|
|
message/different-types
|
|
|
|
:::
|
|
|
|
## Closable
|
|
|
|
A close button can be added.
|
|
|
|
:::demo A default Message cannot be closed manually. If you need a closable message, you can set `showClose` field. Besides, same as notification, message has a controllable `duration`. Default duration is 3000 ms, and it won't disappear when set to `0`.
|
|
|
|
message/closable
|
|
|
|
:::
|
|
|
|
## Centered text
|
|
|
|
Use the `center` attribute to center the text.
|
|
|
|
:::demo
|
|
|
|
message/centered-content
|
|
|
|
:::
|
|
|
|
## Use HTML string
|
|
|
|
`message` supports HTML string.
|
|
|
|
:::demo Set `dangerouslyUseHTMLString` to true and `message` will be treated as an HTML string.
|
|
|
|
message/raw-html
|
|
|
|
:::
|
|
|
|
:::warning
|
|
|
|
Although `message` property supports HTML strings, dynamically rendering arbitrary HTML on your website can be very dangerous because it can easily lead to [XSS attacks](https://en.wikipedia.org/wiki/Cross-site_scripting). So when `dangerouslyUseHTMLString` is on, please make sure the content of `message` is trusted, and **never** assign `message` to user-provided content.
|
|
|
|
:::
|
|
|
|
## Global method
|
|
|
|
Element Plus has added a global method `$message` for `app.config.globalProperties`. So in a vue instance you can call `Message` like what we did in this page.
|
|
|
|
## Local import
|
|
|
|
```ts
|
|
import { ElMessage } from 'element-plus'
|
|
```
|
|
|
|
In this case you should call `ElMessage(options)`. We have also registered methods for different types, e.g. `ElMessage.success(options)`. You can call `ElMessage.closeAll()` to manually close all the instances.
|
|
|
|
## Options
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
| ------------------------ | ------------------------------------------------------------------------------ | -------------------- | -------------------------- | ------------- |
|
|
| message | message text | string / VNode | — | — |
|
|
| type | message type | string | success/warning/info/error | info |
|
|
| icon-class | custom icon's class, overrides `type` | string | — | — |
|
|
| dangerouslyUseHTMLString | whether `message` is treated as HTML string | boolean | — | false |
|
|
| custom-class | custom class name for Message | string | — | — |
|
|
| duration | display duration, millisecond. If set to 0, it will not turn off automatically | number | — | 3000 |
|
|
| show-close | whether to show a close button | boolean | — | false |
|
|
| center | whether to center the text | boolean | — | false |
|
|
| on-close | callback function when closed with the message instance as the parameter | function | — | — |
|
|
| offset | set the distance to the top of viewport | number | — | 20 |
|
|
| appendTo | set the root element for the message | string / HTMLElement | - | document.body |
|
|
|
|
## Methods
|
|
|
|
`Message` and `this.$message` returns the current Message instance. To manually close the instance, you can call `close` on it.
|
|
| Method | Description |
|
|
| ---- | ---- |
|
|
| close | close the Message |
|