Message全局提示
全局展示操作反馈信息。
何时使用
可提供成功、警告和错误等反馈信息。
顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。
代码演示
信息提醒反馈。
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
。
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 。
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);
包括成功、失败、警告。
import { message, Button } 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(
<div>
<Button onClick={success}>Success</Button>
<Button onClick={error}>Error</Button>
<Button onClick={warning}>Warning</Button>
</div>,
mountNode,
);
进行全局 loading,异步自行移除。
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
来更新内容。
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,
);
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 warningmessage.loading(content, [duration], onClose)
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
content | 提示内容 | string|ReactNode|config | - |
duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭。 | number | 3 |
onClose | 关闭时触发的回调函数 | Function | - |
组件同时提供 promise 接口。
其中message[level]
是组件已经提供的静态方法。then
接口返回值是 Promise。
也可以对象的形式传递参数:
message.open(config)
message.success(config)
message.error(config)
message.info(config)
message.warning(config)
message.warn(config)
// alias of warningmessage.loading(config)
config
对象属性如下:
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
content | 提示内容 | ReactNode | - |
duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭。 | number | 3 |
onClose | 关闭时触发的回调函数 | Function | - |
icon | 自定义图标 | ReactNode | - |
key | 当前提示的唯一标志 | string|number | - |
全局方法
还提供了全局配置和全局销毁方法:
message.config(options)
message.destroy()
message.config
message.config({
top: 100,
duration: 2,
maxCount: 3,
});
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
duration | 默认自动关闭延时,单位秒 | number | 3 |
getContainer | 配置渲染节点的输出位置 | () => HTMLElement | () => document.body |
maxCount | 最大显示数, 超过限制时,最早的消息会被自动关闭 | number | - |
top | 消息距离顶部的位置 | number | 24 |