Message全局提示

全局展示操作反馈信息。

何时使用

  • 可提供成功、警告和错误等反馈信息。

  • 顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。

代码演示

Message全局提示 - 图1

普通提示

信息提醒反馈。

  1. import { message, Button } from 'antd';
  2. const info = () => {
  3. message.info('This is a normal message');
  4. };
  5. ReactDOM.render(
  6. <Button type="primary" onClick={info}>
  7. Display normal message
  8. </Button>,
  9. mountNode,
  10. );

Message全局提示 - 图2

修改延时

自定义时长 10s,默认时长为 3s

  1. import { message, Button } from 'antd';
  2. const success = () => {
  3. message.success('This is a prompt message for success, and it will disappear in 10 seconds', 10);
  4. };
  5. ReactDOM.render(<Button onClick={success}>Customized display duration</Button>, mountNode);

Message全局提示 - 图3

Promise 接口

可以通过 then 接口在关闭后运行 callback 。以上用例将在每个 message 将要结束时通过 then 显示新的 message 。

  1. import { message, Button } from 'antd';
  2. const success = () => {
  3. message
  4. .loading('Action in progress..', 2.5)
  5. .then(() => message.success('Loading finished', 2.5))
  6. .then(() => message.info('Loading finished is finished', 2.5));
  7. };
  8. ReactDOM.render(<Button onClick={success}>Display sequential messages</Button>, mountNode);

Message全局提示 - 图4

其他提示类型

包括成功、失败、警告。

  1. import { message, Button } from 'antd';
  2. const success = () => {
  3. message.success('This is a success message');
  4. };
  5. const error = () => {
  6. message.error('This is an error message');
  7. };
  8. const warning = () => {
  9. message.warning('This is a warning message');
  10. };
  11. ReactDOM.render(
  12. <div>
  13. <Button onClick={success}>Success</Button>
  14. <Button onClick={error}>Error</Button>
  15. <Button onClick={warning}>Warning</Button>
  16. </div>,
  17. mountNode,
  18. );

Message全局提示 - 图5

加载中

进行全局 loading,异步自行移除。

  1. import { message, Button } from 'antd';
  2. const success = () => {
  3. const hide = message.loading('Action in progress..', 0);
  4. // Dismiss manually and asynchronously
  5. setTimeout(hide, 2500);
  6. };
  7. ReactDOM.render(<Button onClick={success}>Display a loading indicator</Button>, mountNode);

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 时不自动关闭。number3
onClose关闭时触发的回调函数Function-

组件同时提供 promise 接口。

  • messagelevel.then(afterClose)

  • messagelevel.then(afterClose)

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

  • message.open(config)
参数说明类型默认值版本
content提示内容ReactNode-
duration自动关闭的延时,单位秒。设为 0 时不自动关闭。number3
onClose关闭时触发的回调函数Function-
icon自定义图标ReactNode-3.9.0

全局方法

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

  • message.config(options)

  • message.destroy()

message.config

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