mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 03:29:59 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
2.6 KiB
2.6 KiB
category | type | noinstant | title | subtitle |
---|---|---|---|---|
Components | 反馈 | true | Notification | 通知提醒框 |
全局展示通知提醒信息。
何时使用
在系统四个角显示通知提醒信息。经常用于以下情况:
- 较为复杂的通知内容。
- 带有交互的通知,给出用户下一步的行动点。
- 系统主动推送。
API
notification.success(config)
notification.error(config)
notification.info(config)
notification.warning(config)
notification.warn(config)
notification.open(config)
notification.close(key: String)
notification.destroy()
config 参数如下:
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
btn | 自定义关闭按钮 | ReactNode | - | |
bottom | 消息从底部弹出时,距离底部的位置,单位像素。 | number | 24 | |
className | 自定义 CSS class | string | - | |
description | 通知提醒内容,必选 | string|ReactNode | - | |
duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | number | 4.5 | |
getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | |
icon | 自定义图标 | ReactNode | - | |
key | 当前通知唯一标志 | string | - | |
message | 通知提醒标题,必选 | string|ReactNode | - | |
onClose | 点击默认关闭按钮时触发的回调函数 | Function | - | |
onClick | 点击通知时触发的回调函数 | Function | - | 3.11.0 |
placement | 弹出位置,可选 topLeft topRight bottomLeft bottomRight |
string | topRight | |
style | 自定义内联样式 | React.CSSProperties | - | |
top | 消息从顶部弹出时,距离顶部的位置,单位像素。 | number | 24 |
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
notification.config(options)
notification.config({
placement: 'bottomRight',
bottom: 50,
duration: 3,
});
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
bottom | 消息从底部弹出时,距离底部的位置,单位像素。 | number | 24 | |
duration | 默认自动关闭延时,单位秒 | number | 4.5 | |
getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | |
placement | 弹出位置,可选 topLeft topRight bottomLeft bottomRight |
string | topRight | |
top | 消息从顶部弹出时,距离顶部的位置,单位像素。 | number | 24 |