mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 03:29:59 +08:00
Code Issues Actions 35 Packages Projects Releases Wiki Activity
a614a525c4
ant-design/components/message/index.en-US.md
Jinxuan Zhu c2519e776b Add promise-like interface (#10470) 
* Add promise-like interface

* Keep hide interface

* Shorten

* Test Promise

* Update document

* Update demo: 2.5 second is insignificant with the default 3s hiding

* Update demo: then  interface

* Fix line break

* Chainable

* Thenable demo

* Thenable test

* Fix tsc error

* Fix tsc error

* Better document

* Revert change in loading.md

* Change snapshot
2018-05-25 20:41:07 +08:00

1.9 KiB
Raw Blame History

category type noinstant title
Components Feedback true Message

Display global messages as feedback in response to user operations.

When To Use

  • To provide feedback such as success, warning, error etc.
  • A message is displayed at top and center and will be dismissed automatically, as a non-interrupting light-weighted prompt.

API

This components provides some static methods, with usage and arguments as following:

  • message.success(content, [duration], onClose)
  • message.error(content, [duration], onClose)
  • message.info(content, [duration], onClose)
  • message.warning(content, [duration], onClose)
  • message.warn(content, [duration], onClose) // alias of warning
  • message.loading(content, [duration], onClose)
Argument Description Type Default
content content of the message string|ReactNode -
duration time(seconds) before auto-dismiss, don't dismiss if set to 0 number 1.5
onClose Specify a function that will be called when the message is closed Function -

Methods for global configuration and destruction are also provided:

  • message.config(options)
  • message.destroy()

afterClose can be called in then-able interface:

  • message[level](content, [duration]).then(afterClose)
  • message[level](content, [duration], onClose).then(afterClose)

where level refers one static methods of message. The result of then method will be a Promise.

message.config

message.config({
  top: 100,
  duration: 2,
  maxCount: 3,
});
Argument Description Type Default
duration time before auto-dismiss, in seconds number 1.5
getContainer Return the mount node for Message () => HTMLElement () => document.body
top distance from top number 24
maxCount max message show, drop oldest if exceed limit number -