消息弹出框
模拟系统的消息提示框而实现的一套模态对话框组件,用于消息提示、确认消息和提交内容。
提示
从场景上说,MessageBox 的作用是美化系统自带的 alert、confirm 和 prompt,因此适合展示较为简单的内容。 如果需要弹出较为复杂的内容,请使用 Dialog。
消息提示
消息提示,用于在用户执行操作时,中断其当前操作,直至用户确认知晓。
确认消息
确认消息用于询问用户是否确认执行某项操作。
提交内容
当需要用户输入时,可以使用提交内容的弹框。
使用 VNode
message 属性支持传入 VNode。
自定义
可自定义消息弹窗的样式,以满足各种需求。
使用 HTML 片段
message 属性支持 HTML 片段。
警告
message 属性虽然支持传入 HTML 片段,但是在网站上动态渲染任意 HTML 是非常危险的,因为容易导致 XSS 攻击。 因此,当 dangerouslyUseHTMLString 打开的情况下,请确保 message 的内容是可信的,永远不要将用户提交的内容赋值给 message 属性。
区分取消与关闭
在某些场景下,点击取消按钮与点击关闭按钮有着不同的含义。
内容居中
MessageBox 的内容可以居中。
自定义图标
图标可以自定义为任意 Vue 组件或渲染函数 (JSX)。
可拖拽
MessageBox 是可以拖拽的。
全局方法
如果 Element Plus 被完整引入,它会为 app.config.globalProperties 添加如下全局方法:$msgbox, $alert, $confirm 和 $prompt。 因此在 Vue 实例中可以像本页面一样调用 MessageBox。 参数如下:
$msgbox(options)$alert(message, title, options)或$alert(message, options)$confirm(message, title, options)或$confirm(message, options)$prompt(message, title, options)或$prompt(message, options)
应用上下文继承 > 2.0.4
现在 message box 接受一个 context 作为消息构造函数的第二个参数(如果你使用的是 message box 的变体,则是第四个参数),它允许你将当前应用的上下文注入到消息中,这样就可以继承应用的所有属性。
import { getCurrentInstance } from 'vue'
import { ElMessageBox } from 'element-plus'
// in your setup method
const { appContext } = getCurrentInstance()!
// You can pass it like:
ElMessageBox({}, appContext)
// or if you are using variants
ElMessageBox.alert('Hello world!', 'Title', {}, appContext)局部导入
如果你更倾向于按需引入 MessageBox:
import { ElMessageBox } from 'element-plus'对应的方法是: ElMessageBox, ElMessageBox.alert, ElMessageBox.confirm 和 ElMessageBox.prompt. 参数与上述相同。
API
配置项
| 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| 自动聚焦 | 打开 MessageBox 时是否自动获得焦点 | boolean | true |
| title | MessageBox 的标题 | string | '' |
| message | MessageBox 的内容 | string / VNode / Function 2.2.17 | — |
| dangerouslyUseHTMLString | message 是否被当作 HTML 字符串处理 | boolean | false |
| type | 消息类型,用于显示图标 | 枚举 | '' |
| icon | 自定义图标组件,该配置会覆盖 type 的图标 | string / Component | '' |
| closeIcon 2.9.5 | 自定义关闭图标组件,默认为 Close | string / Component | '' |
| customClass | MessageBox 的自定义类名 | string | '' |
| customStyle | MessageBox 的自定义内联样式 | CSSProperties | {} |
| 遮罩层 | 是否显示遮罩层 | boolean | true |
| modalClass | 遮罩层的自定义类名 | string | — |
| callback | 若不使用 Promise,可以使用此回调函数 | Function | null |
| showClose | 是否显示右上角的关闭按钮 | boolean | true |
| beforeClose | MessageBox 关闭前的回调,会暂停实例的关闭 | Function | null |
| distinguishCancelAndClose | 是否区分取消和关闭 | boolean | false |
| lockScroll | MessageBox 出现时是否锁定滚动条 | boolean | true |
| showCancelButton | 是否显示取消按钮 | boolean | false(在 confirm 和 prompt 中为 true) |
| showConfirmButton | 是否显示确定按钮 | boolean | true |
| cancelButtonText | 取消按钮的文本内容 | string | 取消 |
| confirmButtonText | 确定按钮的文本内容 | string | 确定 |
| cancelButtonLoadingIcon 2.7.7 | 取消按钮的加载图标内容 | string / Component | 加载中 |
| confirmButtonLoadingIcon 2.7.7 | 确认按钮的加载图标内容 | string / Component | 加载中 |
| cancelButtonClass | 取消按钮的自定义类名 | string | '' |
| confirmButtonClass | 确定按钮的自定义类名 | string | '' |
| closeOnClickModal | 是否可通过点击遮罩层关闭 MessageBox | boolean | true(在 alert 中为 false) |
| closeOnPressEscape | 是否可通过按下 ESC 键关闭 MessageBox | boolean | true(在 alert 中为 false) |
| closeOnHashChange | 是否在 hash 改变时关闭 MessageBox | boolean | true |
| showInput | 是否显示输入框 | boolean | false(在 prompt 中为 true) |
| inputPlaceholder | 输入框占位文本 | string | '' |
| inputType | 输入框类型,更多信息见 MDN | string | 文本 |
| inputValue | 输入框的初始值 | string | '' |
| inputPattern | 输入框的正则表达式 | 正则表达式 | null |
| inputValidator | 输入框的验证函数。应该返回一个布尔值或一个字符串。如果返回一个字符串, 它将被赋值给 inputErrorMessage | Function/ undefined | undefined |
| inputErrorMessage | 验证失败时的错误提示文本 | string | 输入的数据不合法 |
| 居中 | 是否将内容居中 | boolean | false |
| draggable | MessageBox 是否可拖拽 | boolean | false |
| overflow 2.5.4 | 可拖拽的 MessageBox 是否可以超出视口 | boolean | false |
| roundButton | 是否使用圆角按钮 | boolean | false |
| buttonSize | 确认和取消按钮的自定义尺寸 | string | default |
| appendTo 2.2.19 | 设置消息框的根元素 | CSSSelector / HTMLElement | — |