mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-24 19:19:57 +08:00
Code Issues Actions 31 Packages Projects Releases Wiki Activity
77b78a9389
ant-design/components/message/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

1.5 KiB
Raw Blame History

category type noinstant title
Components Feedback true Message

Display global messages as feedbacks to user operations.

When To Use

  • To provide feedbacks 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

  • message.success(content, duration)
  • message.error(content, duration)
  • message.info(content, duration)
  • message.warning(content, duration)
  • message.warn(content, duration)
  • message.loading(content, duration)

This components provides 4 static methods, with arguments as following:

Argument Description Type Default
content content of the message string|ReactNode -
duration time before auto-dismiss,in seconds number 1.5

Methods for global configuration and destruction are also provided:

  • message.config(options)
  • message.destroy()
message.config({
  top: 100,
  duration: 2,
});
Argument Description Type Default
top distance to top number 24px
duration time before auto-dismiss,in seconds number 1.5