

<DemoTitle title="Notification" desc="用于指示任务的完成进度">
#### API

<AntdApiRef url="https://ant.design/components/notification-cn/#api"></AntdApiRef>


## antd API

通用属性参考：[通用属性](/docs/react/common-props)


- `notification.success(config)`
- `notification.error(config)`
- `notification.info(config)`
- `notification.warning(config)`
- `notification.open(config)`
- `notification.destroy(key?: String)`

config 参数如下：

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| actions | 自定义按钮组 | ReactNode | - | 5.24.0 | 
| className | 自定义 CSS class | string | - | - | 
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0：设置为 null 或 false 时隐藏关闭按钮 | 
| description | 通知提醒内容，必选 | ReactNode | - | - | 
| duration | 默认 4.5 秒后自动关闭，配置为 null 则不自动关闭 | number | 4.5 | - | 
| showProgress | 显示自动关闭通知框的进度条 | boolean |  | 5.18.0 | 
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 | 
| icon | 自定义图标 | ReactNode | - | - | 
| key | 当前通知唯一标志 | string | - | - | 
| message | 通知提醒标题，必选 | ReactNode | - | - | 
| placement | 弹出位置，可选  | string | topRight | - | 
| style | 自定义内联样式 |  | - | - | 
| role | 供屏幕阅读器识别的通知内容语义，默认为  | alert \| status | alert | 5.6.0 | 
| onClick | 点击通知时触发的回调函数 | function | - | - | 
| onClose | 当通知关闭时触发 | function | - | - | 
| props | 透传至通知  | Object | - | - | 


- `notification.useNotification(config)`

config 参数如下：

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 |  | 
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0：设置为 null 或 false 时隐藏关闭按钮 | 
| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body |  | 
| placement | 弹出位置，可选  | string | topRight |  | 
| showProgress | 显示自动关闭通知框的进度条 | boolean |  | 5.18.0 | 
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 | 
| rtl | 是否开启 RTL 模式 | boolean | false |  | 
| stack | 堆叠模式，超过阈值时会将所有消息收起 | boolean \|  | { threshold: 3 } | 5.10.0 | 
| top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 |  | 
| maxCount | 最大显示数，超过限制时，最早的消息会被自动关闭 | number | - | 4.17.0 | 


### 全局配置

还提供了一个全局配置方法，在调用前提前配置，全局一次生效。

`notification.config(options)`

当你使用 `ConfigProvider` 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用，可通过如下设置开启 RTL 模式。


```js
notification.config({
  placement: 'bottomRight',
  bottom: 50,
  duration: 3,
  rtl: true,
});
```


#### notification.config

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 |  | 
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0：设置为 null 或 false 时隐藏关闭按钮 | 
| duration | 默认自动关闭延时，单位秒 | number | 4.5 |  | 
| showProgress | 显示自动关闭通知框的进度条 | boolean |  | 5.18.0 | 
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 | 
| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLNode | () => document.body |  | 
| placement | 弹出位置，可选  | string | topRight |  | 
| rtl | 是否开启 RTL 模式 | boolean | false |  | 
| top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 |  | 
| maxCount | 最大显示数，超过限制时，最早的消息会被自动关闭 | number | - | 4.17.0 |