Message 全局提示
全局展示操作反馈信息。
何时使用
- 可提供成功、警告和错误等反馈信息。
- 顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。
代码演示
普通提示
信息提醒反馈。
import React from 'react';
import ReactDOM from 'react-dom';
import { message, Button } from 'choerodon-ui';
const info = () => {
message.info('This is a normal message');
};
ReactDOM.render(
<Button type="primary" onClick={info}>Display normal message</Button>,
document.getElementById('container'));
其他提示类型
包括成功、失败、警告。
import React from 'react';
import ReactDOM from 'react-dom';
import { message, Button } from 'choerodon-ui';
message.config({
top: '24px',
});
const success = () => {
message.success('This is a message of success');
};
const error = () => {
message.error('This is a message of error');
};
const warning = () => {
message.warning('This is message of warning');
};
ReactDOM.render(
<div>
<Button onClick={success}>Success</Button>
<Button onClick={error}>Error</Button>
<Button onClick={warning}>Warning</Button>
</div>,
document.getElementById('container'));
修改延时
自定义时长 10s
,默认时长为 3s
。
import React from 'react';
import ReactDOM from 'react-dom';
import { message, Button } from 'choerodon-ui';
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>,
document.getElementById('container'));
加载中
进行全局 loading,异步自行移除。
import React from 'react';
import ReactDOM from 'react-dom';
import { message, Button } from 'choerodon-ui';
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>,
document.getElementById('container'));
消息位置
定义消息位置
import React from 'react';
import ReactDOM from 'react-dom';
import { message, Button } from 'choerodon-ui';
const handleClick = (placement) => {
message.destroy();
message.config({
top: 100,
bottom: 100,
duration: 5,
});
message.success(placement, undefined, undefined, placement);
};
ReactDOM.render(
<div>
<Button onClick={() => { handleClick('topLeft'); }}>topLeft</Button>
<Button onClick={() => { handleClick('top'); }}>top</Button>
<Button onClick={() => { handleClick('topRight'); }}>topRight</Button>
<Button onClick={() => { handleClick('leftTop'); }}>leftTop</Button>
<Button onClick={() => { handleClick('left'); }}>left</Button>
<Button onClick={() => { handleClick('leftBottom'); }}>leftBottom</Button>
<Button onClick={() => { handleClick('rightTop'); }}>rightTop</Button>
<Button onClick={() => { handleClick('right'); }}>right</Button>
<Button onClick={() => { handleClick('rightBottom'); }}>rightBottom</Button>
<Button onClick={() => { handleClick('bottomLeft'); }}>bottomLeft</Button>
<Button onClick={() => { handleClick('bottom'); }}>bottom</Button>
<Button onClick={() => { handleClick('bottomRight'); }}>bottomRight</Button>
</div>,
document.getElementById('container'));
API
组件提供了一些静态方法,使用方式和参数如下:
message.success(content, [duration], [onClose], placement)
message.error(content, [duration], [onClose], placement)
message.info(content, [duration], [onClose], placement)
message.warning(content, [duration], [onClose], placement)
message.warn(content, [duration], [onClose], placement)
// alias of warningmessage.loading(content, [duration], [onClose], placement)
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
content | 提示内容 | string|ReactNode | - |
duration | 自动关闭的延时,单位秒 | number | 3 |
onClose | 关闭时触发的回调函数 | Function | - |
placement | 消息展示的位置, 可选值: top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottom | string | leftBottom |
还提供了全局配置和全局销毁方法:
message.config(options)
message.destroy()
message.config
message.config({
top: 100,
duration: 2,
});
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
duration | 默认自动关闭延时,单位秒 | number | 3 |
getContainer | 配置渲染节点的输出位置 | () => HTMLElement | () => document.body |
top | 消息在顶部出现时距离顶部的位置 | number | 24 |
bottom | 消息在底部出现时距离底部的位置 | number | 24 |
placement | 消息展示的位置, 可选值: top left right bottom topLeft topRight bottomLeft bottomRight leftTop leftBottom rightTop rightBottom | string | leftBottom |
当前内容版权归 Choerodon UI 或其关联方所有,如需对内容或内容相关联开源项目进行关注与资助,请访问 Choerodon UI .