element/examples/docs/message.md
2016-08-19 14:45:08 +08:00

5.9 KiB
Raw Blame History

基本用法

Message 系统了反馈提示,它比 Notification 更为小巧,可以根据需要来使用它们,在配置上,它们非常类似,所以部分 Notification 的 options 我们不会做详尽解释,文末有 options 列表,可以结合 Notification 的文档理解它们。

Element 注册了一个$message方法用于调用Message 同样接收一个options字面量,message参数能定义正文内容,下面是最简单的样例:

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

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

不同状态

Message 同样提供了四种类型:successinfowarningerror,由不同图标表示,设置type字段来定义它们,默认为info,如果设置其他值将被忽略。

你可以通过下面的按钮来体验它们:

成功 警告 错误
<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="open4">错误</el-button>
</template>

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

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

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

可关闭

默认的 Message 是不可以被人工关闭的,如果需要可关闭的 Message可以使用showClose字段,它接受一个Booleantrue为允许关闭。

注意:和 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)

Options

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