ant-design/components/notification/index.en-US.md

category	type	noinstant	english
Components	Views	true	Notification

To display a notification message globally.

When to use

To display a notification message at the top right of the view port. 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.close(key: String)
• notification.destroy()

The properties of config are as follows:

Property	Description	Type	Default
message	The title of notification box (required)	React.Element or String	No
description	The content of notification box (required)	React.Element or String	No
btn	Custom close button	React.Element	No
key	The unique identifer of current notification	String	No
onClose	Specify a function that will be called after clicking the default close button	Function	No
duration	A notification box is closed after 4.5s by default. When specifying duration to null or 0, it will never be closed automatically	Number	4.5

Notification also provide 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 before displaying.

• notification.config(options)

notification.config({
  top: 100,
  duration: 3,
});

Property	Description	Type	Default
top	Offset to top of message	Number	24px
duration	A duration to close notification automatically by default (unit: second)	Number	4.5