Message全局提示

全局展示操作反馈信息。

何时使用#

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

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

代码演示

信息提醒反馈。

expand codeexpand code
import { message, Button } from 'antd';

const info = () => {
  message.info('This is a normal message');
};

ReactDOM.render(
  <Button type="primary" onClick={info}>
    Display normal message
  </Button>,
  mountNode,
);

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

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message.success('This is a prompt message for success, and it will disappear in 10 seconds', 10);
};

ReactDOM.render(<Button onClick={success}>Customized display duration</Button>, mountNode);

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

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message
    .loading('Action in progress..', 2.5)
    .then(() => message.success('Loading finished', 2.5))
    .then(() => message.info('Loading finished is finished', 2.5));
};

ReactDOM.render(<Button onClick={success}>Display sequential messages</Button>, mountNode);

使用 styleclassName 来定义样式。

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message.success({
    content: 'This is a prompt message with custom className and style',
    className: 'custom-class',
    style: {
      marginTop: '20vh',
    },
  });
};

ReactDOM.render(<Button onClick={success}>Customized style</Button>, mountNode);

包括成功、失败、警告。

expand codeexpand code
import { message, Button, Space } from 'antd';

const success = () => {
  message.success('This is a success message');
};

const error = () => {
  message.error('This is an error message');
};

const warning = () => {
  message.warning('This is a warning message');
};

ReactDOM.render(
  <Space>
    <Button onClick={success}>Success</Button>
    <Button onClick={error}>Error</Button>
    <Button onClick={warning}>Warning</Button>
  </Space>,
  mountNode,
);

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

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  const hide = message.loading('Action in progress..', 0);
  // Dismiss manually and asynchronously
  setTimeout(hide, 2500);
};

ReactDOM.render(<Button onClick={success}>Display a loading indicator</Button>, mountNode);

可以通过唯一的 key 来更新内容。

expand codeexpand code
import { Button, message } from 'antd';

const key = 'updatable';

const openMessage = () => {
  message.loading({ content: 'Loading...', key });
  setTimeout(() => {
    message.success({ content: 'Loaded!', key, duration: 2 });
  }, 1000);
};

ReactDOM.render(
  <Button type="primary" onClick={openMessage}>
    Open the message box
  </Button>,
  mountNode,
);

通过 message.useMessage 创建支持读取 context 的 contextHolder

expand codeexpand code
import { message, Button } from 'antd';

const Context = React.createContext({ name: 'Default' });

function Demo() {
  const [messsageApi, contextHolder] = message.useMessage();
  const info = () => {
    messsageApi.open({
      type: 'info',
      content: <Context.Consumer>{({ name }) => `Hello, ${name}!`}</Context.Consumer>,
      duration: 1,
    });
  };

  return (
    <Context.Provider value={{ name: 'Ant Design' }}>
      {contextHolder}
      <Button type="primary" onClick={info}>
        Display normal message
      </Button>
    </Context.Provider>
  );
}

ReactDOM.render(<Demo />, 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提示内容ReactNode | config-
duration自动关闭的延时,单位秒。设为 0 时不自动关闭number3
onClose关闭时触发的回调函数function-

组件同时提供 promise 接口。

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

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

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

也可以对象的形式传递参数:

  • message.open(config)

  • message.success(config)

  • message.error(config)

  • message.info(config)

  • message.warning(config)

  • message.warn(config) // alias of warning

  • message.loading(config)

config 对象属性如下:

参数说明类型默认值
className自定义 CSS classstring-
content提示内容ReactNode-
duration自动关闭的延时,单位秒。设为 0 时不自动关闭number3
icon自定义图标ReactNode-
key当前提示的唯一标志string | number-
style自定义内联样式CSSProperties-
onClose关闭时触发的回调函数function-

全局方法#

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

  • message.config(options)

  • message.destroy()

也可通过 message.destroy(key) 来关闭一条消息。

message.config#

当你使用 ConfigProvider 进行全局化配置时,系统会默认自动开启 RTL 模式。(4.3.0+)

当你想单独使用,可通过如下设置开启 RTL 模式。

message.config({
  top: 100,
  duration: 2,
  maxCount: 3,
  rtl: true,
  prefixCls: 'my-message',
});
参数说明类型默认值版本
duration默认自动关闭延时,单位秒number3
getContainer配置渲染节点的输出位置() => HTMLElement() => document.body
maxCount最大显示数, 超过限制时,最早的消息会被自动关闭number-
prefixCls消息节点的 className 前缀stringant-message4.5.0
rtl是否开启 RTL 模式booleanfalse
top消息距离顶部的位置number24

FAQ#

为什么 message 不能获取 context、redux 的内容和 ConfigProvider 的 locale/prefixCls 配置?#

直接调用 message 方法,antd 会通过 ReactDOM.render 动态创建新的 React 实体。其 context 与当前代码所在 context 并不相同,因而无法获取 context 信息。

当你需要 context 信息(例如 ConfigProvider 配置的内容)时,可以通过 message.useMessage 方法会返回 api 实体以及 contextHolder 节点。将其插入到你需要获取 context 位置即可:

const [api, contextHolder] = message.useMessage();

return (
  <Context1.Provider value="Ant">
    {/* contextHolder 在 Context1 内,它可以获得 Context1 的 context */}
    {contextHolder}
    <Context2.Provider value="Design">
      {/* contextHolder 在 Context2 外,因而不会获得 Context2 的 context */}
    </Context2.Provider>
  </Context1.Provider>
);

异同:通过 hooks 创建的 contextHolder 必须插入到子元素节点中才会生效,当你不需要上下文信息时请直接调用。

Drawer抽屉Modal对话框