ant-design-vue/components/notification/index.zh-CN.md

55 lines
2.0 KiB
Markdown
Raw Normal View History

2018-02-05 21:06:39 +08:00
## 何时使用
在系统四个角显示通知提醒信息。经常用于以下情况:
- 较为复杂的通知内容。
- 带有交互的通知,给出用户下一步的行动点。
- 系统主动推送。
## API
- `notification.success(config)`
- `notification.error(config)`
- `notification.info(config)`
- `notification.warning(config)`
- `notification.warn(config)`
update to antd3.8.3 (#159) * refactor: align * feat: update align to 2.4.3 * feat: update trigger 2.5.4 * feat: update tooltip 3.7.2 * fix: align * feat: update vc-calendar to 9.6.2 * feat: update vc-checkbox to 2.1.5 * feat: update vc-dialog to 7.1.8 * feat: update vc-from to 2.2.1 * feat: update vc-notification to 3.1.1 * test: update snapshots * feat: update vc-tree to 1.12.6 * feat: update vc-table to 6.2.8 * feat: update vc-upload to 2.5.1 * feat: update vc-input-number to 4.0.12 * feat: update vc-tabs to 9.2.6 * refactor: vc-menu * refactor: update vc-menu to 7.0.5 * style: remove unused * feat: update pagination to 1.16.5 * feat: add vc-progress 2.2.5 tag * feat: add vc-rate 2.4.0 tag * feat: update vc-slider to 8.6.1 * fix: tooltip error * style: delete conosle * feat: update vc-steps to 3.1.1 * add vc-switch tag 1.6.0 * feat: update upload to 2.5.1 * fix: update vc-menu * fix: update store * fix: add ref dir * fix: trigger mock shouldComponentUpdate * fix: update vc-select * revert: trigger lazyrenderbox * fix: update vc-select * fix: update vc-select * fix: update vc-select * fix: update vc-menu * fix: update vc-slick ref * update style to 3.8.2 * test: update snapshots * update vc-select * update util & affix * feat: add drawer * fix: support title add slot mode * test: update affix test * update alert * update anchor * update snapshots * fix: doc and vc-drawer * update select & auto-complete * update back-top & grid * feractor: avatar * test: add drawer test * update badge * update button * update card * update divider * feat: update vc-tabs to 9.3.6 and tabs * add afterEnter callback * update form * fix: update drawer * test: update snapshots * update modal & notification * test: update snapshots * update message * update locale-provider * update dropdown * update layout popconfirm popover * update time-picker * update menu * update date-picker * docs: update input docs * update input * update snapshots * update table * update test snapshots * feat: update progress * update checkbox * feat: update spin * update radio * docs: slider steps timeline * update list * update transfer * update collapse * update cascader * update upload
2018-09-05 21:28:54 +08:00
- `notification.open(config)`
2018-02-05 21:06:39 +08:00
- `notification.close(key: String)`
- `notification.destroy()`
config 参数如下:
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
2018-02-06 15:21:13 +08:00
| btn | 自定义关闭按钮 | vueNode \|function(h) | - |
| class | 自定义 CSS class | string | - |
| description | 通知提醒内容,必选 | string \|vueNode \|function(h) | - |
2018-02-05 21:06:39 +08:00
| duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | number | 4.5 |
2018-02-06 15:21:13 +08:00
| icon | 自定义图标 | vueNode \|function(h) | - |
2018-02-05 21:06:39 +08:00
| key | 当前通知唯一标志 | string | - |
2018-02-06 15:21:13 +08:00
| message | 通知提醒标题,必选 | string \|vueNode \|function(h) | - |
2018-02-05 21:06:39 +08:00
| placement | 弹出位置,可选 `topLeft` `topRight` `bottomLeft` `bottomRight` | string | topRight |
2018-02-06 15:21:13 +08:00
| style | 自定义内联样式 | Object \| string | - |
2018-02-05 21:06:39 +08:00
| onClose | 点击默认关闭按钮时触发的回调函数 | Function | - |
2019-01-05 10:55:03 +08:00
| onClick | 点击通知时触发的回调函数 | Function | - |
2018-02-05 21:06:39 +08:00
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
- `notification.config(options)`
```js
notification.config({
placement: 'bottomRight',
2018-02-06 15:21:13 +08:00
bottom: '50px',
2018-02-05 21:06:39 +08:00
duration: 3,
});
```
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
2018-02-06 15:21:13 +08:00
| bottom | 消息从底部弹出时,距离底部的位置,单位像素。 | string | `24px` |
2018-02-05 21:06:39 +08:00
| duration | 默认自动关闭延时,单位秒 | number | 4.5 |
| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body |
| placement | 弹出位置,可选 `topLeft` `topRight` `bottomLeft` `bottomRight` | string | topRight |
2018-02-06 15:21:13 +08:00
| top | 消息从顶部弹出时,距离顶部的位置,单位像素。 | string | `24px` |