Message全局提示
Message
全局提示
全局展示操作反馈信息。
使用import{ message }from"antd"; |
文档编辑此页 |
- 组件总览
- 通用
- 布局
- 导航
- 数据录入
- 数据展示
- 反馈
- 其他
通过 message.useMessage 创建支持读取 context 的 contextHolder。请注意，我们推荐通过顶层注册的方式代替 message 静态方法，因为静态方法无法消费上下文，因而 ConfigProvider 的数据也不会生效。
自定义时长 10s，默认时长为 3s。
可以通过 then 接口在关闭后运行 callback 。以上用例将在每个 message 将要结束时通过 then 显示新的 message 。
可以通过唯一的 key 来更新内容。
包括成功、失败、警告。
进行全局 loading，异步自行移除。
使用 style 和 className 来定义样式。
静态方法无法消费 Context，推荐优先使用 Hooks 版本。
通用属性参考：通用属性
组件提供了一些静态方法，使用方式和参数如下：
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 时不自动关闭 | 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)message.success(config)message.error(config)message.info(config)message.warning(config)message.loading(config)config 对象属性如下：
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| className | 自定义 CSS class | string | - |
| content | 提示内容 | ReactNode | - |
| duration | 自动关闭的延时，单位秒。设为 0 时不自动关闭 | number | 3 |
| icon | 自定义图标 | ReactNode | - |
| key | 当前提示的唯一标志 | string | number | - |
| style | 自定义内联样式 | CSSProperties | - |
| onClick | 点击 message 时触发的回调函数 | function | - |
| onClose | 关闭时触发的回调函数 | function | - |
还提供了全局配置和全局销毁方法：
message.config(options)message.destroy()也可通过
message.destroy(key)来关闭一条消息。
当你使用
ConfigProvider进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用，可通过如下设置开启 RTL 模式。
message.config({top: 100,duration: 2,maxCount: 3,rtl: true,prefixCls: 'my-message',});
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| duration | 默认自动关闭延时，单位秒 | number | 3 | |
| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLElement | () => document.body | |
| maxCount | 最大显示数，超过限制时，最早的消息会被自动关闭 | number | - | |
| prefixCls | 消息节点的 className 前缀 | string | ant-message | 4.5.0 |
| rtl | 是否开启 RTL 模式 | boolean | false | |
| top | 消息距离顶部的位置 | number | 8 |
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| contentBg | 提示框背景色 | string | #ffffff |
| contentPadding | 提示框内边距 | undefined | Padding<string | number> | 9px 12px |
| zIndexPopup | 提示框 z-index | number | 2010 |
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 的问题。
你可以通过 ConfigProvider.config 进行设置。