mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-26 20:20:00 +08:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity
20fa17b8b1
ant-design/components/message/index.zh-CN.md
MuYu fb0b4f0fc9 docs: show version Number features were added (#17373) 
* docs: add api first appearance

* docs: fix auto-complete doc

* docs: replace Version Added with Version

* docs: date picker common method

* docs: date picker common method

* docs: tree

* docs: remove meaningless 3.0.0
2019-07-11 14:14:33 +08:00

2.7 KiB
Raw Blame History

category subtitle type noinstant title
Components 全局提示 反馈 true Message

全局展示操作反馈信息。

何时使用

  • 可提供成功、警告和错误等反馈信息。
  • 顶部居中显示并自动消失，是一种不打断用户操作的轻量级提示方式。

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|ReactNode -
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 提示内容 ReactNode -
duration 自动关闭的延时，单位秒。设为 0 时不自动关闭。 number 3
onClose 关闭时触发的回调函数 Function -
icon 自定义图标 ReactNode - 3.9.0

全局方法

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

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

message.config

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