ElementPlus Message 消息提示

2021-09-26 16:35 更新

Message 消息提示

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

基础用法

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


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

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

<script>
  import { defineComponent, h } from 'vue'
  import { ElMessage } from 'element-plus'
  export default defineComponent({
    setup() {
      return {
        open() {
          ElMessage('只是一条消息提示')
        },
        openVn() {
          ElMessage({
            message: h('p', null, [
              h('span', null, '内容可以是 '),
              h('i', { style: 'color: teal' }, 'VNode'),
            ]),
          })
        },
      }
    },
  })
</script>

不同状态

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


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

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

<script>
  import { defineComponent } from 'vue'
  import { ElMessage } from 'element-plus'
  export default defineComponent({
    setup() {
      return {
        open1() {
          ElMessage.success({
            message: '恭喜你,这是一条成功消息',
            type: 'success',
          })
        },
        open2() {
          ElMessage.warning({
            message: '警告哦,这是一条警告消息',
            type: 'warning',
          })
        },
        open3() {
          ElMessage('这是一条消息提示')
        },
        open4() {
          ElMessage.error('错了哦,这是一条错误消息')
        },
      }
    },
  })
</script>

可关闭

可以添加关闭按钮。


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

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

<script>
  import { defineComponent } from 'vue'
  import { ElMessage } from 'element-plus'

  export default defineComponent({
    setup() {
      return {
        open1() {
          ElMessage({
            showClose: true,
            message: '这是一条消息提示',
          })
        },

        open2() {
          ElMessage({
            showClose: true,
            message: '恭喜你,这是一条成功消息',
            type: 'success',
          })
        },

        open3() {
          ElMessage({
            showClose: true,
            message: '警告哦,这是一条警告消息',
            type: 'warning',
          })
        },

        open4() {
          ElMessage({
            showClose: true,
            message: '错了哦,这是一条错误消息',
            type: 'error',
          })
        },
      }
    },
  })
</script>

文字居中

使用 center 属性让文字水平居中。


<template>
  <el-button :plain="true" @click="openCenter">文字居中</el-button>
</template>

<script>
  import { defineComponent } from 'vue'
  import { ElMessage } from 'element-plus'
  export default defineComponent({
    setup() {
      return {
        openCenter() {
          ElMessage({
            message: '居中的文字',
            center: true,
          })
        },
      }
    },
  })
</script>

使用 HTML 片段

message 属性支持传入 HTML 片段


将dangerouslyUseHTMLString属性设置为 true,message 就会被当作 HTML 片段处理。

<template>
  <el-button :plain="true" @click="openHTML">使用 HTML 片段</el-button>
</template>

<script>
  import { defineComponent } from 'vue'
  import { ElMessage } from 'element-plus'
  export default defineComponent({
    setup() {
      return {
        openHTML() {
          ElMessage({
            dangerouslyUseHTMLString: true,
            message: '<strong>这是 <i>HTML</i> 片段</strong>',
          })
        },
      }
    },
  })
</script>

message 属性虽然支持传入 HTML 片段,但是在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 XSS 攻击。因此在 dangerouslyUseHTMLString 打开的情况下,请确保 message 的内容是可信的,永远不要将用户提交的内容赋值给 message 属性。

全局方法

Element Plus 为 app.config.globalProperties 添加了全局方法 $message。因此在 vue instance 中可以采用在 method 中调用 this.$message方法唤起ElMessage。

单独引用

import { ElMessage } from 'element-plus'
JS

此时调用方法为 ElMessage(options)。我们也为每个 type 定义了各自的方法,如 ElMessage.success(options)。并且可以调用 ElMessage.closeAll() 手动关闭所有实例。

Options

参数说明类型可选值默认值
message消息文字string / VNode
type主题stringsuccess/warning/info/errorinfo
iconClass自定义图标的类名,会覆盖 typestring
dangerouslyUseHTMLString是否将 message 属性作为 HTML 片段处理booleanfalse
customClass自定义类名string
duration显示时间, 毫秒。设为 0 则不会自动关闭number3000
showClose是否显示关闭按钮booleanfalse
center文字是否居中booleanfalse
onClose关闭时的回调函数, 参数为被关闭的 message 实例function
offsetMessage 距离窗口顶部的偏移量number20

方法

调用 ElMessage 或 this.$message 会返回当前 Message 的实例。如果需要手动关闭实例,可以调用它的 close 方法。

方法名说明
close关闭当前的 Message


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号