全局提示

全局展示操作反馈信息。

何时使用

  • 可提供成功、警告和错误等反馈信息。
  • 顶部居中显示并自动消失,是一种不打断用户操作的轻量级提示方式。

代码演示

Display normal message

普通提示

信息提醒反馈。

  1. <template>
  2. <a-button type="primary" @click="info">
  3. Display normal message
  4. </a-button>
  5. </template>
  6. <script>
  7. export default {
  8. methods: {
  9. info() {
  10. this.$message.info('This is a normal message');
  11. },
  12. },
  13. };
  14. </script>

Display a loading indicator

加载中

进行全局 loading,异步自行移除。

  1. <template>
  2. <a-button @click="success">
  3. Display a loading indicator
  4. </a-button>
  5. </template>
  6. <script>
  7. export default {
  8. methods: {
  9. success() {
  10. const hide = this.$message.loading('Action in progress..', 0);
  11. setTimeout(hide, 2500);
  12. },
  13. },
  14. };
  15. </script>

Display a sequence of message

Promise 接口

可以通过 then 接口在关闭后运行 callback 。以上用例将在每个 message 将要结束时通过 then 显示新的 message 。

  1. <template>
  2. <a-button @click="success">
  3. Display a sequence of message
  4. </a-button>
  5. </template>
  6. <script>
  7. export default {
  8. methods: {
  9. success() {
  10. this.$message
  11. .loading('Action in progress..', 2.5)
  12. .then(() => this.$message.success('Loading finished', 2.5))
  13. .then(() => this.$message.info('Loading finished is finished', 2.5));
  14. },
  15. },
  16. };
  17. </script>

Customized display duration

修改延时

自定义时长 10s,默认时长为 3s

  1. <template>
  2. <a-button @click="success">
  3. Customized display duration
  4. </a-button>
  5. </template>
  6. <script>
  7. export default {
  8. methods: {
  9. success() {
  10. this.$message.success(
  11. 'This is a prompt message for success, and it will disappear in 10 seconds',
  12. 10,
  13. );
  14. },
  15. },
  16. };
  17. </script>

Message全局提示 - 图1

其他提示类型

包括成功、失败、警告。

  1. <template>
  2. <div>
  3. <a-button @click="success">
  4. Success
  5. </a-button>
  6. <a-button @click="error">
  7. Error
  8. </a-button>
  9. <a-button @click="warning">
  10. Warning
  11. </a-button>
  12. </div>
  13. </template>
  14. <script>
  15. export default {
  16. methods: {
  17. success() {
  18. this.$message.success('This is a success message');
  19. },
  20. error() {
  21. this.$message.error('This is an error message');
  22. },
  23. warning() {
  24. this.$message.warning('This is a warning message');
  25. },
  26. },
  27. };
  28. </script>

Open the message box

更新消息内容

可以通过唯一的 key 来更新内容。

  1. <template>
  2. <a-button type="primary" @click="openMessage">
  3. Open the message box
  4. </a-button>
  5. </template>
  6. <script>
  7. const key = 'updatable';
  8. export default {
  9. methods: {
  10. openMessage() {
  11. this.$message.loading({ content: 'Loading...', key });
  12. setTimeout(() => {
  13. this.$message.success({ content: 'Loaded!', key, duration: 2 });
  14. }, 1000);
  15. },
  16. },
  17. };
  18. </script>

API

组件提供了一些静态方法,使用方式和参数如下:

  • 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)
参数说明类型默认值
content提示内容string| VNode |(h) => VNode-
duration自动关闭的延时,单位秒。设为 0 时不自动关闭。number3
onClose关闭时触发的回调函数Function-

组件同时提供 promise 接口

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

其中message[level] 是组件已经提供的静态方法。then 接口返回值是 Promise 。

也可以对象的形式传递参数:

  • message.open(config)
  • message.success(config)
  • message.error(config)
  • message.info(config)
  • message.warning(config)
  • message.warn(config) // alias of warning
  • message.loading(config)
参数说明类型默认值版本
content提示内容string| VNode |(h) => VNode-
duration自动关闭的延时,单位秒。设为 0 时不自动关闭。number3
onClose关闭时触发的回调函数Function-
icon自定义图标string| VNode |(h) => VNode-
key当前提示的唯一标志string|number-1.5.0

全局方法

还提供了全局配置和全局销毁方法:

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

message.config

  1. message.config({
  2. top: `100px`,
  3. duration: 2,
  4. maxCount: 3,
  5. });
参数说明类型默认值
duration默认自动关闭延时,单位秒number3
getContainer配置渲染节点的输出位置() => HTMLElement() => document.body
maxCount最大显示数, 超过限制时,最早的消息会被自动关闭number-
top消息距离顶部的位置string24px