ant-design/components/notification/index.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
chinese: 通知提醒框
2016-05-11 14:21:01 +08:00
type: Presentation
2016-03-31 14:17:09 +08:00
noinstant: true
english: Notification
---
2015-07-22 11:06:55 +08:00
2015-07-28 15:40:28 +08:00
全局展示通知提醒信息。
## 何时使用
2015-08-05 21:18:34 +08:00
在系统右上角显示通知提醒信息。经常用于以下情况:
- 较为复杂的通知内容。
- 带有交互的通知,给出用户下一步的行动点。
- 系统主动推送。
2015-07-28 15:40:28 +08:00
## API
2015-08-04 15:16:10 +08:00
- `notification.success(config)`
- `notification.error(config)`
- `notification.info(config)`
2016-03-28 14:38:25 +08:00
- `notification.warning(config)`
2015-08-04 15:16:10 +08:00
- `notification.close(key: String)`
- `notification.destroy()`
2015-08-04 15:16:10 +08:00
config 参数如下:
2015-07-28 15:40:28 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|----------- |--------------------------------------------- | ----------- |--------|
2015-08-04 15:20:43 +08:00
| message | 通知提醒标题,必选 | React.Element or String | 无 |
| description | 通知提醒内容,必选 | React.Element or String | 无 |
2015-08-04 15:16:10 +08:00
| btn | 自定义关闭按钮 | React.Element | 无 |
2015-08-04 17:41:12 +08:00
| key | 当前通知唯一标志 | String | 无 |
2015-07-30 21:04:52 +08:00
| onClose | 点击默认关闭按钮时触发的回调函数 | Function | 无 |
2015-08-29 13:02:37 +08:00
| duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | Number | 4.5 |
2015-08-04 15:48:00 +08:00
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
2015-08-04 15:16:10 +08:00
- `notification.config(options)`
```js
2016-02-25 17:07:31 +08:00
notification.config({
top: 100,
duration: 3,
2015-08-04 15:16:10 +08:00
});
```
2015-08-04 15:48:00 +08:00
2015-08-04 15:16:10 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|------------|--------------------|----------------------------|--------------|
| top | 消息距离顶部的位置 | Number | 24px |
| duration | 默认自动关闭延时,单位秒 | Number | 4.5 |