Skip to content

Message 消息提示

常用于主动操作后的反馈提示,以轻量浮层形式展示,可通过函数式 API 调用。

基础用法

通过 ZcMessage 函数调用,支持传入字符串或配置对象。

不同类型

通过 type 属性设置消息类型,支持 infosuccesswarningdanger

可关闭与持续时间

通过 showClose 显示关闭按钮,duration 控制自动关闭时间(毫秒)。

居中显示

通过 center 属性使消息文字居中。

Message API

Options

参数说明类型默认值
message消息文字内容string
type消息类型info | success | warning | dangerinfo
duration显示时间(毫秒),0 为常驻number3000
showClose是否显示关闭按钮booleanfalse
center是否居中显示booleanfalse
offset距离顶部的偏移量(px)number20
onClose关闭时的回调函数() => void

Events

事件名说明回调参数
close消息关闭时触发

快捷方式

ZcMessage 提供以下快捷方法:

  • ZcMessage.info(options) - 信息提示
  • ZcMessage.success(options) - 成功提示
  • ZcMessage.warning(options) - 警告提示
  • ZcMessage.danger(options) - 错误/危险提示

每个快捷方法均接受字符串或配置对象(不含 type 字段)。

导出

名称描述
ZcMessage消息函数,含类型快捷方法
ZcMessageCloseAll关闭所有消息实例

注意事项

  • SSR 兼容性ZcMessage 依赖 document 对象,在 SSR 环境中调用需确保仅在客户端执行(如放在 onMounted 中)。
  • 自动关闭:默认 3 秒后自动关闭。设置 duration: 0 可实现手动关闭,此时需调用返回实例的 close() 方法。
  • 堆叠偏移:多条消息会自动堆叠排列并计算偏移量,无需手动管理位置。
  • 性能建议:避免在短时间内频繁创建大量消息实例,应及时调用 close()ZcMessageCloseAll() 清理。

基于 MIT 许可发布