Skip to content

Message 消息提示

常用于主动操作后的反馈提示。 与 Notification 的区别是后者更多用于系统级通知的被动提醒。

基础用法

从顶部出现,3 秒后自动消失。

不同状态

用来显示「成功、警告、消息、错误」类的操作反馈。

可关闭的消息提示

可以添加关闭按钮。

使用 HTML 片段作为正文内容

message 还支持使用 HTML 字符串作为正文内容。

WARNING

message 属性虽然支持传入 HTML 片段,但是在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 XSS 攻击。 因此在 dangerouslyUseHTMLString 打开的情况下,请确保 message 的内容是可信的,永远不要将用户提交的内容赋值给 message 属性。

全局方法

Vangle 为 app.config.globalProperties 添加了全局方法 $message。 因此在 vue 实例中你可以使用当前页面中的调用方式调用 Message

单独引用

ts
import { VanMessage } from 'vangle'
import { VanMessage } from 'vangle'

此时调用方法为 VanMessage(options)。 我们也为每个 type 定义了各自的方法,如 VanMessage.success(options)。 并且可以调用 VanMessage.closeAll() 手动关闭所有实例。

Message API

Message 配置项

属性说明类型默认值
message消息文字string | VNode | (() => VNode)
type消息类型'success' | 'warning' | 'info' | 'error''info'
icon自定义图标,该属性会覆盖 type 的图标。string | Component
dangerouslyUseHTMLString是否将 message 属性作为 HTML 片段处理booleanfalse
custom-class自定义类名string
duration显示时间,单位为毫秒。 设为 0 则不会自动关闭number3000
show-close是否显示关闭按钮booleanfalse
center文字是否居中booleanfalse
on-close关闭时的回调函数, 参数为被关闭的 message 实例function
offsetMessage 距离窗口顶部的偏移量number20
appendTo设置组件的根元素string | HTMLElementdocument.body

Message 方法

调用 Messagethis.$message 会返回当前 Message 的实例。 如果需要手动关闭实例,可以调用它的 close 方法。

方法名描述
close关闭当前的 Message

Released under the MIT License.