mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-26 04:00:13 +08:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
77b78a9389
ant-design/components/notification/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636) 
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

2.4 KiB
Raw Blame History

category type noinstant title
Components Feedback 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) string|ReactNode -
description The content of notification box (required) string|ReactNode -
btn Customized close button ReactNode -
icon Customized icon ReactNode _
key The unique identifier of current notification string -
onClose Specify a function that will be called after clicking the default close button Function -
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