ant-design/components/notification/index.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

2015-07-22 11:06:55 +08:00
# Notification
- category: Components
2015-07-28 15:40:28 +08:00
- chinese: 通知提醒框
2015-07-22 11:06:55 +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)`
- `notification.warn(config)`
- `notification.open(config)`
- `notification.close(key: String)`
config 参数如下:
2015-07-28 15:40:28 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|----------- |--------------------------------------------- | ----------- |--------|
2015-08-04 15:16:10 +08:00
| message | 通知提醒标题,必选 | React.Element|String | 无 |
| description | 通知提醒内容,必选 | React.Element|String | 无 |
| btn | 自定义关闭按钮 | React.Element | 无 |
| key | 当前通知唯一标志 | String | 无 |
2015-07-30 21:04:52 +08:00
| onClose | 点击默认关闭按钮时触发的回调函数 | Function | 无 |
2015-08-04 15:16:10 +08:00
还提供了一个全局配置方法:
- `notification.config(options)`
```js
message.config({
top: 100
});
```
| 参数 | 说明 | 类型 | 默认值 |
|------------|--------------------|----------------------------|--------------|
| top | 消息距离顶部的位置 | Number | 24px |