element/examples/docs/zh-CN/message.md
2016-11-07 23:33:33 +08:00

5.5 KiB
Raw Blame History

Message 消息提示

常用于主动操作后的反馈提示。与 Notification 的区别是后者更多用于系统级通知的被动提醒。

基础用法

从顶部出现3 秒后自动消失。

:::demo Message 在配置上与 Notification 非常类似,所以部分 options 在此不做详尽解释,文末有 options 列表,可以结合 Notification 的文档理解它们。Element 注册了一个$message方法用于调用Message 可以接收一个字符串作为参数,它会被显示为正文内容。

<template>
  <el-button :plain="true" @click.native="open">打开消息提示</el-button>
</template>

<script>
  export default {
    methods: {
      open() {
        this.$message('这是一条消息提示');
      }
    }
  }
</script>

:::

不同状态

用来显示「成功、警告、消息、错误」类的操作反馈。

:::demo 当需要自定义更多属性时Message 也可以接收一个对象为参数。比如,设置type字段可以定义不同的状态,默认为info。此时正文内容以message的值传入。同时,我们也为 Message 的各种 type 注册了方法,可以在不传入type字段的情况下像open4那样直接调用。

<template>
  <el-button :plain="true" @click.native="open2">成功</el-button>
  <el-button :plain="true" @click.native="open3">警告</el-button>
  <el-button :plain="true" @click.native="open">消息</el-button>
  <el-button :plain="true" @click.native="open4">错误</el-button>
</template>

<script>
  export default {
    methods: {
      open2() {
        this.$message({
          message: '恭喜你,这是一条成功消息',
          type: 'success'
        });
      },

      open3() {
        this.$message({
          message: '警告哦,这是一条警告消息',
          type: 'warning'
        });
      },

      open4() {
        this.$message.error('错了哦,这是一条错误消息');
      }
    }
  }
</script>

:::

可关闭

可以添加关闭按钮。

:::demo 默认的 Message 是不可以被人工关闭的,如果需要可手动关闭的 Message可以使用showClose字段。此外,和 Notification 一样Message 拥有可控的duration,设置0为不会被自动关闭,默认为 3000 毫秒。

<template>
  <el-button :plain="true" @click.native="open5">消息</el-button>
  <el-button :plain="true" @click.native="open6">成功</el-button>
  <el-button :plain="true" @click.native="open7">警告</el-button>
  <el-button :plain="true" @click.native="open8">错误</el-button>
</template>

<script>
  export default {
    methods: {
      open5() {
        this.$message({
          showClose: true,
          message: '恭喜你,这是一条成功消息'
        });
      },

      open6() {
        this.$message({
          showClose: true,
          message: '警告哦,这是一条警告消息',
          type: 'warning'
        });
      },

      open7() {
        this.$message({
          showClose: true,
          message: '错了哦,这是一条错误消息',
          type: 'error'
        });
      },

      open8() {
        this.$message({
          showClose: true,
          message: '错了哦,这是一条错误消息',
          type: 'error'
        });
      }
    }
  }
</script>

:::

全局方法

element 为 Vue.prototype 添加了全局方法 $message。因此在 vue instance 中可以采用本页面中的方式调用 Message

单独引用

单独引入 Message

import { Message } from 'element-ui';

此时调用方法为 Message(options)。我们也为每个 type 定义了各自的方法,如 Message.success(options)

Options

参数 说明 类型 可选值 默认值
message 消息文字 string
type 主题 string success/warning/info/error info
duration 显示时间, 毫秒。设为 0 则不会自动关闭 number 3000
showClose 是否显示关闭按钮 boolean false
onClose 关闭时的回调函数, 参数为被关闭的 message 实例 function