JGuang

全局提示

Message · Ant Design

交互预览
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

全局提示

全局展示操作反馈信息。

何时使用

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

代码演示

  • Hooks 调用(推荐) · hooks
  • 其他提示类型 · other
  • 修改延时 · duration
  • 堆叠 · stack
  • 加载中 · loading
  • Promise 接口 · thenable
  • 自定义语义结构样式 · style-class
  • 更新消息内容 · update
  • 静态方法(不推荐) · info

API

通用属性参考:通用属性

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

  • message.success(content, [duration], onClose)
  • message.error(content, [duration], onClose)
  • message.info(content, [duration], onClose)
  • message.warning(content, [duration], onClose)
  • 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.loading(config)

config 对象属性如下:

参数说明类型默认值版本全局配置
className自定义 CSS classstring--5.7.0
classNames用于自定义组件内部各语义化结构的 class,支持对象或函数Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-6.0.06.0.0
content提示内容ReactNode--×
duration自动关闭的延时,单位秒。设为 0 时不自动关闭number3-×
icon自定义图标ReactNode--×
pauseOnHover悬停时是否暂停计时器booleantrue-×
key当前提示的唯一标志string | number--×
style自定义内联样式CSSProperties--5.7.0
styles用于自定义组件内部各语义化结构的行内 style,支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-6.0.06.0.0
onClick点击 message 时触发的回调函数function--×
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×
stack堆叠模式,超过阈值时会将所有消息收起。折叠状态下仅展示最新的消息boolean | { threshold: number }false6.4.0×
top消息距离顶部的位置string | number8×

Semantic DOM

语义节点原生说明版本
root消息项根元素,设置背景色、圆角、阴影、内边距和动画样式6.0.0
wrapper图标与标题的包裹元素,设置内容布局、间距和对齐样式6.4.0
icon图标元素,设置字体大小、行高和状态颜色样式6.0.0
title标题元素,设置文本颜色、字号、行高和内容展示样式6.4.0
list消息列表根元素,设置定位、层级、宽度、滚动区域和位置样式6.4.0
listContent消息列表内容元素,设置消息项排列、间距和高度动画样式6.4.0

语义说明来源: vendor/components/message/demo/_semantic.tsx

主题变量(Design Token)

类型、继承关系和原生令牌声明保持固定源码原文;默认值由原生主题计算,并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。

令牌类型原生说明
zIndexPopupnumber提示框 z-index
contentBgstring提示框背景色
contentPaddingCSSProperties['padding']提示框内边距

声明来源: vendor/components/message/style/index.ts

import type { CSSProperties } from 'react';

import type { CSSObject } from '@ant-design/cssinjs';

import { unit } from '@ant-design/cssinjs';

import { CONTAINER_MAX_OFFSET } from '../../_util/hooks';

import { prepareNotificationToken, sharedGenerateStyle } from '../../notification/style';

import type { NotificationToken } from '../../notification/style';

import { genListItemSharedStyle } from '../../notification/style/notification';

import type { GenerateStyle, GenStyleFn, GetDefaultToken } from '../../theme/internal';

import { genStyleHooks, genSubStyleComponent, mergeToken } from '../../theme/internal';

/** Component only token. Which will handle additional calculation of alias token */
export interface ComponentToken {
  // Component token here
  /**
   * @desc 提示框 z-index
   * @descEN z-index of Message
   */
  zIndexPopup: number;
  /**
   * @desc 提示框背景色
   * @descEN Background color of Message
   */
  contentBg: string;
  /**
   * @desc 提示框内边距
   * @descEN Padding of Message
   */
  contentPadding: CSSProperties['padding'];
}

FAQ

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

直接调用 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 必须插入到子元素节点中才会生效,当你不需要上下文信息时请直接调用。

可通过 App 包裹组件 简化 useMessage 等方法需要手动植入 contextHolder 的问题。

静态方法如何设置 prefixCls ?

你可以通过 ConfigProvider.config 进行设置。

原生通用属性

Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。

参数说明类型默认值
style自定义样式CSSProperties-
className自定义类名string-
rootClassName添加在组件最外层的 classNamestring-
autoFocus自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效booleanfalse

安装并复现示例

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

原生类型参考

源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

  • vendor/components/message/PureList.tsx
  • vendor/components/message/PurePanel.tsx
  • vendor/components/message/index.tsx
  • vendor/components/message/interface.ts
  • vendor/components/message/style/index.ts
  • vendor/components/message/useMessage.tsx

来源与许可

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。