# MessageBox 弹框

模拟系统的消息提示框而实现的一套模态对话框组件,用于消息提示、确认消息和提交内容。

提示

从场景上说,MessageBox 的作用是美化系统自带的 alertconfirmprompt,因此适合展示较为简单的内容。如果需要弹出较为复杂的内容,请使用 Dialog。

# 消息提示

当用户进行操作时会被触发,该对话框中断用户操作,直到用户确认知晓后才可关闭。

调用$alert 方法即可打开消息提示,它模拟了系统的 alert,无法通过按下 ESC 或点击框外关闭。此例中接收了两个参数,message 和 title。值得一提的是,窗口被关闭后,它默认会返回一个 Promise 对象便于进行后续操作的处理。若不确定浏览器是否支持 Promise,可自行引入第三方 polyfill 或像本例一样使用回调进行后续处理。

<template>
  <jp-button type="text" @click="open">点击打开 Message Box</jp-button>
</template>

<script>
export default {
  methods: {
    open() {
      this.$alert('这是一段内容', '标题名称', {
        confirmButtonText: '确定',
        callback: (action) => {
          this.$message({
            type: 'info',
            message: `action: ${action}`
          })
        }
      })
    }
  }
}
</script>
显示代码

# Options

参数 说明 类型 可选值 默认值
title MessageBox 标题 string
message MessageBox 消息正文内容 string / VNode
dangerouslyUseHTMLString 是否将 message 属性作为 HTML 片段处理 boolean false
type 消息类型,用于显示图标 string success / info / warning / error
iconClass 自定义图标的类名,会覆盖 type string
customClass MessageBox 的自定义类名 string
callback 若不使用 Promise,可以使用此参数指定 MessageBox 关闭后的回调 function(action, instance),action 的值为'confirm', 'cancel'或'close', instance 为 MessageBox 实例,可以通过它访问实例上的属性和方法
showClose MessageBox 是否显示右上角关闭按钮 boolean true
beforeClose MessageBox 关闭前的回调,会暂停实例的关闭 function(action, instance, done),action 的值为'confirm', 'cancel'或'close';instance 为 MessageBox 实例,可以通过它访问实例上的属性和方法;done 用于关闭 MessageBox 实例
distinguishCancelAndClose 是否将取消(点击取消按钮)与关闭(点击关闭按钮或遮罩层、按下 ESC 键)进行区分 boolean false
lockScroll 是否在 MessageBox 出现时将 body 滚动锁定 boolean true
showCancelButton 是否显示取消按钮 boolean false(以 confirm 和 prompt 方式调用时为 true)
showConfirmButton 是否显示确定按钮 boolean true
cancelButtonText 取消按钮的文本内容 string 取消
confirmButtonText 确定按钮的文本内容 string 确定
cancelButtonClass 取消按钮的自定义类名 string
confirmButtonClass 确定按钮的自定义类名 string
closeOnClickModal 是否可通过点击遮罩关闭 MessageBox boolean true(以 alert 方式调用时为 false)
closeOnPressEscape 是否可通过按下 ESC 键关闭 MessageBox boolean true(以 alert 方式调用时为 false)
closeOnHashChange 是否在 hashchange 时关闭 MessageBox boolean true
showInput 是否显示输入框 boolean false(以 prompt 方式调用时为 true)
inputPlaceholder 输入框的占位符 string
inputType 输入框的类型 string text
inputValue 输入框的初始文本 string
inputPattern 输入框的校验表达式 regexp
inputValidator 输入框的校验函数。可以返回布尔值或字符串,若返回一个字符串, 则返回结果会被赋值给 inputErrorMessage function
inputErrorMessage 校验未通过时的提示文本 string 输入的数据不合法!
center 是否居中布局 boolean false
roundButton 是否使用圆角按钮 boolean false