# MessageBox 弹框组件
从场景上说,MessageBox 的作用是美化系统自带的 alert
、confirm
和 prompt
,因此适合展示较为简单的内容。如果需要弹出较为复杂的内容,请使用 Dialog。
消息提示
当用户进行操作时会被触发,该对话框中断用户操作,直到用户确认知晓后才可关闭。
调用$tlbsAlert
方法即可打开消息提示,它模拟了系统的 alert
,无法通过按下 ESC 或点击框外关闭。此例中接收了两个参数,message
和title
。窗口被关闭后,它默认会返回一个Promise
对象便于进行后续操作的处理。若不确定浏览器是否支持Promise
,可自行引入第三方 polyfill 或像本例一样使用回调进行后续处理。
确认消息
提示用户确认其已经触发的动作,并询问是否进行该操作时会用到此对话框。
调用$confirm
方法即可打开消息提示,它模拟了系统的 confirm
。Message Box 组件也拥有极高的定制性,我们可以传入options
作为第三个参数,它是一个字面量对象。type
字段表明消息类型,可以为success
,error
,info
和warning
,无效的设置将会被忽略。注意,第二个参数title
必须定义为String
类型,如果是Object
,会被理解为options
。在这里我们用了 Promise 来处理后续响应。
提交内容
当用户进行操作时会被触发,中断用户操作,提示用户进行输入的对话框。
调用$tlbsPrompt
方法即可打开消息提示,它模拟了系统的 prompt
。可以用inputPattern
字段自己规定匹配模式,或者用inputValidator
规定校验函数,可以返回Boolean
或String
,返回false
或字符串时均表示校验未通过,同时返回的字符串相当于定义了inputErrorMessage
字段。此外,可以用inputPlaceholder
字段来定义输入框的占位符。
自定义
可自定义配置不同内容。
以上三个方法都是对$tlbsMsgbox
方法的再包装。本例直接调用$tlbsMsgbox
方法,使用了showCancelButton
字段,用于显示取消按钮。另外可使用cancelButtonClass
为其添加自定义样式,使用cancelButtonText
来自定义按钮文本(Confirm 按钮也具有相同的字段,在文末的字段说明中有完整的字段列表)。此例还使用了beforeClose
属性,它的值是一个方法,会在 MessageBox 的实例关闭前被调用,同时暂停实例的关闭。它有三个参数:action
、实例本身和done
方法。使用它能够在关闭前对实例进行一些操作,比如为确定按钮添加loading
状态等;此时若需要关闭实例,可以调用done
方法(若在beforeClose
中没有调用done
,则实例不会关闭)。
区分取消与关闭
有些场景下,点击取消按钮与点击关闭按钮有着不同的含义。
showClose参数默认为false,当设置为true且用户触发取消(点击取消按钮)或触发关闭(点击关闭按钮或遮罩层、按下 ESC 键)时,Promise 的 reject 回调和callback
回调的参数均为 'cancel'。如果将distinguishCancelAndClose
属性设置为 true,则上述两种行为的参数分别为 'cancel' 和 'close'。
# 全局方法
如果你完整引入了 TlbsUI,它会为 Vue.prototype 添加如下全局方法:$tlbsMsgbox, $tlbsAlert, $tlbsConfirm 和 $tlbsPrompt Vue instance 中可以采用本页面中的方式调用 MessageBox。调用参数为:
$tlbsMsgbox(options)
$tlbsAlert(message, title, options)
或$tlbsAlert(message, options)
$tlbsConfirm(message, title, options)
或$tlbsConfirm(message, options)
$tlbsPrompt(message, title, options)
或$tlbsPrompt(message, options)
# 单独引入
import { tlbsMessageBox } from '@tencent/tlbs-ui';
对应于上述四个全局方法的调用方法依次为:tlbsMessageBox, tlbsMessageBox.tlbsAlert, tlbsMessageBox.tlbsConfirm 和 tlbsMessageBox.tlbsPrompt
# 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 | — | false |
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 |