ant-design-vue/components/message/index.zh-CN.md

1.9 KiB

API

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

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

组件同时提供 promise 接口

  • message[level](content, [duration]).then(afterClose)
  • message[level](content, [duration], onClose).then(afterClose)

其中message[level] 是组件已经提供的静态方法。then 接口返回值是 Promise 。

  • message.open(config)
参数 说明 类型 默认值
content 提示内容 string| VNode |(h) => VNode -
duration 自动关闭的延时,单位秒。设为 0 时不自动关闭。 number 3
onClose 关闭时触发的回调函数 Function -
icon 自定义图标 string| VNode |(h) => VNode -

全局方法

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

  • message.config(options)
  • message.destroy()

message.config

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