2018-02-05 13:06:39 +00:00
## API
- `notification.success(config)`
- `notification.error(config)`
- `notification.info(config)`
- `notification.warning(config)`
- `notification.warn(config)`
2018-09-05 13:28:54 +00:00
- `notification.open(config)`
2018-02-05 13:06:39 +00:00
- `notification.close(key: String)`
- `notification.destroy()`
The properties of config are as follows:
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
2018-02-06 07:21:13 +00:00
| btn | Customized close button | vueNode \|function(h) | - |
| class | Customized CSS class | string | - |
| description | The content of notification box (required) | string\| vueNode \|function(h) | - |
2018-02-05 13:06:39 +00:00
| duration | Time in seconds before Notification is closed. When set to 0 or null, it will never be closed automatically | number | 4.5 |
2018-02-06 07:21:13 +00:00
| icon | Customized icon | vueNode \|function(h) | - |
2018-02-05 13:06:39 +00:00
| key | The unique identifier of the Notification | string | - |
2018-02-06 07:21:13 +00:00
| message | The title of notification box (required) | string\|vueNode \|function(h) | - |
2018-02-05 13:06:39 +00:00
| placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
2018-02-06 07:21:13 +00:00
| style | Customized inline style | Object \| string | - |
2018-02-05 13:06:39 +00:00
| onClose | Specify a function that will be called when the close button is clicked | Function | - |
`notification` also provides a global `config()` method that can be used for specifying the default options. Once this method is used, all the notification boxes will take into account these globally defined options when displaying.
- `notification.config(options)`
```js
notification.config({
placement: 'bottomRight',
2018-02-06 07:21:13 +00:00
bottom: '50px',
2018-02-05 13:06:39 +00:00
duration: 3,
});
```
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
2018-02-06 07:21:13 +00:00
| bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels). | string | `24px` |
2018-02-05 13:06:39 +00:00
| duration | Time in seconds before Notification is closed. When set to 0 or null, it will never be closed automatically | number | 4.5 |
| getContainer | Return the mount node for Notification | () => HTMLNode | () => document.body |
| placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
2018-02-06 07:21:13 +00:00
| top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels). | string | `24px` |