Skip to content

Dialog 对话框 ​

基于element-plus dialog组件的二次封装。

基础用法 ​

异步加载提示 ​

属性 ​

属性说明类型默认值是否拓展
model-value / v-model是否显示 Dialogbooleanfalse否
cancel-text取消操作按钮文案;传空字符串隐藏按钮;缺省走 locale 兜底(见快速开始-国际化)string取消(locale 兜底)是
confirm-text确认操作按钮文案;传空字符串隐藏按钮;缺省走 locale 兜底(见快速开始-国际化)string确认(locale 兜底)是
loading异步加载展示层booleanfalse是
width对话框的宽度,Element Plus 默认为 50%,本组件固定为 800enum800是
destroy-on-close当关闭 Dialog 时,销毁其中的元素booleantrue是
close-on-click-modal是否可以通过点击 modal 关闭 Dialogbooleanfalse是
close-on-press-escape是否可以通过按下 ESC 关闭 Dialogbooleanfalse是
titleDialog 对话框的标题,也可通过具名 slot 传入string''否
fullscreen是否为全屏 Dialogbooleanfalse否
topdialog CSS 中的 margin-top 值,默认为 15vhstring''否
modal是否需要遮罩层booleantrue否
modal-class遮罩的自定义类名string—否
append-to-bodyDialog 自身是否插入至 body 元素上。嵌套的 Dialog 必须指定该属性并赋值为 truebooleanfalse否
append-toDialog 挂载到哪个 DOM 元素,将覆盖 append-to-body (版本: 2.4.3)stringbody否
lock-scroll是否在 Dialog 出现时将 body 滚动锁定booleantrue否
open-delaydialog 打开的延时时间,单位毫秒number0否
close-delaydialog 关闭的延时时间,单位毫秒number0否
show-close是否显示关闭按钮booleantrue否
before-close关闭前的回调,会暂停 Dialog 的关闭。回调函数内执行 done 参数方法的时候才是真正关闭对话框的时候。Function—否
draggable为 Dialog 启用可拖拽功能booleanfalse否
overflow拖动范围可以超出可视区booleanfalse否
center是否让 Dialog 的 header 和 footer 部分居中排列booleanfalse否
align-center是否水平垂直对齐对话框booleanfalse否
close-icon自定义关闭图标,默认 Closeenum—否
z-index和原生的 CSS 的 z-index 相同,改变 z 轴的顺序number—否
header-aria-levelheader 的 aria-level 属性string2否

插槽 ​

插槽名说明类型
—Dialog 的内容-
header对话框标题的内容;会替换标题部分,但不会移除关闭按钮。-
footerDialog 按钮操作区的内容-

事件 ​

本组件支持 Element Plus Dialog 的所有原生事件,所有事件会自动透传到底层的 el-dialog 组件。

扩展事件:

事件名说明类型是否拓展
cancel点击取消按钮后关闭对话框并触发Function是
confirm点击确认按钮后触发,不自动关闭对话框,由 v-model 控制Function是

Element Plus 原生事件示例:

事件名说明类型
openDialog 打开的回调Function
openedDialog 打开动画结束时的回调Function
closeDialog 关闭的回调Function
closedDialog 关闭动画结束时的回调Function
open-auto-focus输入焦点聚焦在 Dialog 内容时的回调Function
close-auto-focus输入焦点从 Dialog 内容失焦时的回调Function

💡 多版本兼容:支持 Element Plus 2.x 所有版本,包括未来新增的事件也会自动可用。

基于 MIT 许可发布