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.

Examples

Normal messages as feedbacks.

expand codeexpand code
import { message, Button } from 'antd';

const info = () => {
  message.info('This is a normal message');
};

ReactDOM.render(
  <Button type="primary" onClick={info}>Display normal message</Button>,
  mountNode);

Customize message display duration from default 3s to 10s.

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message.success('This is a prompt message for success, and it will disappear in 10 seconds', 10);
};

ReactDOM.render(
  <Button onClick={success}>Customized display duration</Button>,
  mountNode);

message provides promise interface for onClose. The above example will display a new message when old message is about to finish.

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message.loading('Action in progress..', 2.5)
    .then(() => message.success('Loading finished', 2.5))
    .then(() => message.info('Loading finished is finished', 2.5));
};

ReactDOM.render(
  <Button onClick={success}>Display a sequence of message</Button>,
  mountNode);

Messages of success, error and warning types.

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  message.success('This is a message of success');
};

const error = () => {
  message.error('This is a message of error');
};

const warning = () => {
  message.warning('This is message of warning');
};

ReactDOM.render(
  <div>
    <Button onClick={success}>Success</Button>
    <Button onClick={error}>Error</Button>
    <Button onClick={warning}>Warning</Button>
  </div>,
  mountNode);

Display a global loading indicator, which is dismissed by itself asynchronously.

expand codeexpand code
import { message, Button } from 'antd';

const success = () => {
  const hide = message.loading('Action in progress..', 0);
  // Dismiss manually and asynchronously
  setTimeout(hide, 2500);
};

ReactDOM.render(
  <Button onClick={success}>Display a loading indicator</Button>,
  mountNode);

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)

ArgumentDescriptionTypeDefault
contentcontent of the messagestring|ReactNode-
durationtime(seconds) before auto-dismiss, don't dismiss if set to 0number1.5
onCloseSpecify a function that will be called when the message is closedFunction-

afterClose can be called in thenable 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.open(config)

The properties of config are as follows:

PropertyDescriptionTypeDefault
contentcontent of the messageReactNode-
durationtime(seconds) before auto-dismiss, don't dismiss if set to 0number3
onCloseSpecify a function that will be called when the message is closedfunction-
iconCustomized IconReactNode-

Global static methods#

Methods for global configuration and destruction are also provided:

  • message.config(options)

  • message.destroy()

message.config#

message.config({
  top: 100,
  duration: 2,
  maxCount: 3,
});
ArgumentDescriptionTypeDefault
durationtime before auto-dismiss, in secondsnumber1.5
getContainerReturn the mount node for Message() => HTMLElement() => document.body
maxCountmax message show, drop oldest if exceed limitnumber-
topdistance from topnumber24