Notification 通知提醒框
如果项目中使用的是 1.x 版本的基础组件(@alifd/next),请在左侧导航顶部切换组件版本。
安装方法
- 在命令行中执行以下命令
npm install @icedesign/notification@0.2.2 -S
全局展示通知提醒信息。
组件实现参照 antd 的 Notification 组件,并针对 ICE 做了适配
安装和升级
def add @icedesign/notification
API
notification.success(config)
notification.error(config)
notification.info(config)
notification.warning(config)
notification.close(key: String)
notification.destroy()
config 参数如下:
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
message | 通知提醒标题,必选 | string|ReactNode | - |
description | 通知提醒内容,必选 | string|ReactNode | - |
btn | 自定义关闭按钮 | ReactNode | - |
icon | 自定义图标 | ReactNode | - |
key | 当前通知唯一标志 | string | - |
onClose | 点击默认关闭按钮时触发的回调函数 | Function | - |
duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | number | 4.5 |
placement | 弹出位置,可选 topLeft topRight bottomLeft``bottomRight | string | topRight | ||
getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body |
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
notification.config(options)
IceNotification.config({
placement: 'bottomRight',
bottom: 50,
duration: 3,
});
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
placement | 弹出位置,可选 topLeft topRight bottomLeft``bottomRight | string | topRight | ||
top | 消息从顶部弹出时,距离顶部的位置,单位像素。 | number | 24 |
bottom | 消息从底部弹出时,距离底部的位置,单位像素。 | number | 24 |
duration | 默认自动关闭延时,单位秒 | number | 4.5 |
感谢 Antd 团队
代码示例
本 Demo 演示最基础的用法。
查看源码在线预览
import React, { Component } from 'react';
import ReactDOM from 'react-dom';
import IceNotification from '@icedesign/notification';
import { Button, Icon, Select } from '@icedesign/base';
class App extends Component {
state = {};
basic = () => {
IceNotification.open({
message: '蒹葭苍苍,白露为霜',
description:
'所謂伊人,在水一方。 溯洄從之,道阻且長。 溯游從之,宛在水中央。 蒹葭萋萋,白露未晞。 所謂伊人,在水之湄。 溯洄從之,道...',
});
};
duration = () => {
const args = {
message: '蒹葭苍苍,白露为霜',
description: '不会自动关闭,除非手动点击关闭按钮!',
duration: 0,
};
IceNotification.open(args);
};
icon = () => {
IceNotification.open({
message: '蒹葭苍苍,白露为霜',
description:
'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
icon: <Icon type="credit-level-filling" />,
});
};
placement = () => {
IceNotification.open({
message: 'Notification Title',
description:
'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
});
};
btn = () => {
const close = () => {
console.log(
'Notification was closed. Either the close button was clicked or duration time elapsed.'
);
};
const key = `open${Date.now()}`;
const btnClick = function() {
// to hide notification box
IceNotification.close(key);
};
const btn = (
<Button type="primary" size="small" onClick={btnClick}>
Confirm
</Button>
);
IceNotification.open({
message: 'Notification Title',
description:
'A function will be be called after the notification is closed (automatically after the "duration" time of manually).',
btn,
key,
onClose: close,
});
};
openNotificationWithIcon = (type) => {
IceNotification[type]({
message: 'Notification Title',
description:
'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
});
};
render() {
return (
<div>
<p>
最简单的用法,4.5 秒后自动关闭。
<Button type="primary" onClick={this.basic}>
ClickMe!
</Button>
</p>
<p>
自定义通知框自动关闭的延时,默认`4.5s`,取消自动关闭只要将该值设为 `0`
即可。。
<Button type="primary" onClick={this.duration}>
ClickMe!
</Button>
</p>
<p>
图标可以被自定义。
<Button type="primary" onClick={this.icon}>
ClickMe!
</Button>
</p>
<p>
可以设置通知从右上角、右下角、左下角、左上角弹出。
<Select
defaultValue="topRight"
style={{ width: 120, marginRight: 10 }}
onChange={(val) => {
IceNotification.config({ placement: val });
}}
>
{['topLeft', 'topRight', 'bottomLeft', 'bottomRight'].map((val) => (
<Option key={val} value={val}>
{val}
</Option>
))}
</Select>
<Button type="primary" onClick={this.placement}>
ClickMe!
</Button>
</p>
<p>
自定义关闭按钮的样式和文字。
<Button type="primary" onClick={this.btn}>
ClickMe!
</Button>
</p>
<p>
通知提醒框左侧有图标。
<Button onClick={() => this.openNotificationWithIcon('success')}>
Success
</Button>
<Button onClick={() => this.openNotificationWithIcon('info')}>
Info
</Button>
<Button onClick={() => this.openNotificationWithIcon('warning')}>
Warning
</Button>
<Button onClick={() => this.openNotificationWithIcon('error')}>
Error
</Button>
</p>
</div>
);
}
}
ReactDOM.render(<App />, mountNode);