2016-08-17 11:07:02 +08:00
---
category: Components
2016-11-09 14:43:32 +08:00
type: Feedback
2016-08-17 11:07:02 +08:00
noinstant: true
2016-09-09 13:55:46 +08:00
title: Notification
2016-08-17 11:07:02 +08:00
---
2017-09-11 11:08:34 +08:00
Display a notification message globally.
2016-08-17 11:07:02 +08:00
2016-09-10 13:43:30 +08:00
## When To Use
2017-09-11 11:08:34 +08:00
To display a notification message at any of the four corners of the viewport. Typically it can be
2016-08-17 11:07:02 +08:00
used in the following cases:
- A notification with complex content.
- A notification providing a feedback based on the user interaction. Or it may show some details
about upcoming steps the user may have to follow.
- A notification that is pushed by the application.
## API
- `notification.success(config)`
- `notification.error(config)`
- `notification.info(config)`
- `notification.warning(config)`
- `notification.warn(config)`
- `notification.close(key: String)`
- `notification.destroy()`
The properties of config are as follows:
2017-05-14 00:13:34 +08:00
| Property | Description | Type | Default |
| ----------- | ---------------------------------------- | ----------------- | -------- |
| message | The title of notification box (required) | string\|ReactNode | - |
| description | The content of notification box (required) | string\|ReactNode | - |
| className | Customized CSS class | string | - |
| style | Customized inline style | Object | - |
| btn | Customized close button | ReactNode | - |
2017-09-11 11:08:34 +08:00
| icon | Customized icon | ReactNode | - |
| key | The unique identifier of the Notification | string | - |
| onClose | Specify a function that will be called when the close button is clicked | Function | - |
| duration | Time in seconds before Notification is closed. When set to 0 or null, it will never be closed automatically | number | 4.5 |
| placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
2016-08-17 11:07:02 +08:00
2017-09-11 11:08:34 +08:00
`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.
2016-08-17 11:07:02 +08:00
- `notification.config(options)`
```js
notification.config({
2017-01-27 17:12:25 +08:00
placement: 'bottomRight',
bottom: 50,
2016-08-17 11:07:02 +08:00
duration: 3,
});
```
2017-05-14 00:13:34 +08:00
| Property | Description | Type | Default |
| ------------ | ---------------------------------------- | -------------- | ------------------- |
2017-09-11 11:08:34 +08:00
| placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
| top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels). | number | 24 |
| bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels). | number | 24 |
| 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 |
