Message 消息提示
常用于主动操作后的反馈提示。 与 Notification 的区别是后者更多用于系统级通知的被动提醒。
基础用法
从顶部出现,3 秒后自动消失。
不同状态
用来显示「成功、警告、消息、错误」类的操作反馈。
Plain 2.6.3
设置 plain
为 plain 背景。
可关闭的消息提示
可以添加关闭按钮。
文字居中
使用 center
属性让文字水平居中。
使用 HTML 片段作为正文内容
message
还支持使用 HTML 字符串作为正文内容。
WARNING
message
属性虽然支持传入 HTML 片段,但是在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 XSS 攻击。 因此在 dangerouslyUseHTMLString
打开的情况下,请确保 message
的内容是可信的,永远不要将用户提交的内容赋值给 message
属性。
分组消息合并
合并相同内容的消息。
全局方法
Element Plus 为 app.config.globalProperties
添加了全局方法 $message
。 因此在 vue 实例中你可以使用当前页面中的调用方式调用 Message
单独引用
import { ElMessage } from 'element-plus'
此时调用方法为 ElMessage(options)
。 我们也为每个 type 定义了各自的方法,如 ElMessage.success(options)
。 并且可以调用 ElMessage.closeAll()
手动关闭所有实例。
应用程序上下文继承 2.0.3
现在 Message 接受一条 context
作为消息构造器的第二个参数,允许你将当前应用的上下文注入到 Message 中,这将允许你继承应用程序的所有属性。
你可以像这样使用它:
TIP
如果您全局注册了 ElMessage 组件,它将自动继承应用的上下文环境。
import { getCurrentInstance } from 'vue'
import { ElMessage } from 'element-plus'
// 在你的 setup 方法中
const { appContext } = getCurrentInstance()!
ElMessage({}, appContext)
API
Message 配置项
名称 | 说明 | 类型 | 默认值 |
---|---|---|---|
message | 消息文字 | string / VNode / Function | '' |
type | 消息类型 | enum | info |
plain 2.6.3 | 是否纯色 | boolean | false |
icon | 自定义图标,该属性会覆盖 type 的图标。 | string / Component | — |
dangerouslyUseHTMLString | 是否将 message 属性作为 HTML 片段处理 | boolean | false |
customClass | 自定义类名 | string | '' |
duration | 显示时间,单位为毫秒。 设为 0 则不会自动关闭 | number | 3000 |
showClose | 是否显示关闭按钮 | boolean | false |
center | 文字是否居中 | boolean | false |
onClose | 关闭时的回调函数, 参数为被关闭的 message 实例 | Function | — |
offset | Message 距离窗口顶部的偏移量 | number | 16 |
appendTo | 设置 message 的根元素,默认为 document.body | string / HTMLElement | — |
grouping | 合并内容相同的消息,不支持 VNode 类型的消息 | boolean | false |
repeatNum | 重复次数,类似于 Badge 。当和 grouping 属性一起使用时作为初始数量使用 | number | 1 |
Message 方法
调用 Message
或 this.$message
会返回当前 Message 的实例。 如果需要手动关闭实例,可以调用它的 close
方法。
名称 | 描述 | 类型 |
---|---|---|
close | 关闭当前的 Message | Function |