mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-16 01:29:11 +08:00
105 lines
4.9 KiB
Markdown
105 lines
4.9 KiB
Markdown
---
|
||
category: Components
|
||
type: Feedback
|
||
noinstant: true
|
||
title: Notification
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/Jxm5nw61w/Notification.svg
|
||
---
|
||
|
||
Display a notification message globally.
|
||
|
||
## When To Use
|
||
|
||
To display a notification message at any of the four corners of the viewport. Typically it can be 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.open(config)`
|
||
- `notification.close(key: String)`
|
||
- `notification.destroy()`
|
||
|
||
The properties of config are as follows:
|
||
|
||
| Property | Description | Type | Default |
|
||
| --- | --- | --- | --- |
|
||
| bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels) | number | 24 |
|
||
| btn | Customized close button | ReactNode | - |
|
||
| className | Customized CSS class | string | - |
|
||
| closeIcon | Custom close icon | ReactNode | - |
|
||
| description | The content of notification box (required) | ReactNode | - |
|
||
| 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 |
|
||
| icon | Customized icon | ReactNode | - |
|
||
| key | The unique identifier of the Notification | string | - |
|
||
| message | The title of notification box (required) | ReactNode | - |
|
||
| placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
|
||
| style | Customized inline style | [CSSProperties](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e434515761b36830c3e58a970abf5186f005adac/types/react/index.d.ts#L794) | - |
|
||
| top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels) | number | 24 |
|
||
| onClick | Specify a function that will be called when the notification is clicked | function | - |
|
||
| onClose | Trigger when notification closed | 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)`
|
||
|
||
> When you use `ConfigProvider` for global configuration, the system will automatically start RTL mode by default.(4.3.0+)
|
||
>
|
||
> When you want to use it alone, you can start the RTL mode through the following settings.
|
||
|
||
```js
|
||
notification.config({
|
||
placement: 'bottomRight',
|
||
bottom: 50,
|
||
duration: 3,
|
||
rtl: true,
|
||
});
|
||
```
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels) | number | 24 | |
|
||
| closeIcon | Custom close icon | ReactNode | - | |
|
||
| 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` | |
|
||
| rtl | Whether to enable RTL mode | boolean | false | |
|
||
| top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels) | number | 24 | |
|
||
| maxCount | Max Notification show, drop oldest if exceed limit | number | - | 4.17.0 |
|
||
|
||
## FAQ
|
||
|
||
### Why I can not access context, redux, ConfigProvider `locale/prefixCls` in notification?
|
||
|
||
antd will dynamic create React instance by `ReactDOM.render` when call notification methods. Whose context is different with origin code located context.
|
||
|
||
When you need context info (like ConfigProvider context), you can use `notification.useNotification` to get `api` instance and `contextHolder` node. And put it in your children:
|
||
|
||
```tsx
|
||
const [api, contextHolder] = notification.useNotification();
|
||
|
||
return (
|
||
<Context1.Provider value="Ant">
|
||
{/* contextHolder is inside Context1 which means api will get value of Context1 */}
|
||
{contextHolder}
|
||
<Context2.Provider value="Design">
|
||
{/* contextHolder is outside Context2 which means api will **not** get value of Context2 */}
|
||
</Context2.Provider>
|
||
</Context1.Provider>
|
||
);
|
||
```
|
||
|
||
**Note:** You must insert `contextHolder` into your children with hooks. You can use origin method if you do not need context connection.
|
||
|
||
### How to set static methods prefixCls ？
|
||
|
||
You can config with [`ConfigProvider.config`](</components/config-provider/#ConfigProvider.config()-4.13.0+>)
|