# 全局提示 Message

# API

组件提供了一些静态方法,使用方式和参数如下:

  • H3Message.success(content, [duration], onClose)
  • H3Message.error(content, [duration], onClose)
  • H3Message.info(content, [duration], onClose)
  • H3Message.warning(content, [duration], onClose)
  • H3Message.warn(content, [duration], onClose) // alias of warning
  • H3Message.loading(content, [duration], onClose)
参数 说明 类型 默认值
content 提示内容 string|vueNode |function(h) -
duration 自动关闭的延时,单位秒。设为 0 时不自动关闭。 number 3
onClose 关闭时触发的回调函数 Function -

还提供了全局配置和全局销毁方法:

  • H3Message.config(options)
  • H3Message.destroy()

组件同时提供 promise 接口,以success为例

  • H3Message.success(content, [duration]).then(afterClose)
  • H3Message.success(content, [duration], onClose).then(afterClose)

# H3Message.config

H3Message.config({
  top: `100px`,
  duration: 2,
  maxCount: 3,
});
参数 说明 类型 默认值
duration 默认自动关闭延时,单位秒 number 3
getContainer 配置渲染节点的输出位置 () => HTMLElement () => document.body
maxCount 最大显示数, 超过限制时,最早的消息会被自动关闭 number -
top 消息距离顶部的位置 string 24px