Dialog 对话框

在保留当前页面状态的情况下,告知用户并承载相关操作。

基本用法

Dialog 弹出一个对话框,适合需要定制性更大的场景。

Dialog 对话框 - 图1

需要设置visible属性,它接收Boolean,当为true时显示 Dialog。Dialog 分为两个部分:bodyfooterfooter需要具名为footerslottitle属性用于定义标题,它是可选的,默认值为空。最后,本例还展示了before-close的用法。

  1. <el-button type="text" @click="dialogVisible = true">点击打开 Dialog</el-button>
  2. <el-dialog
  3. title="提示"
  4. v-model="dialogVisible"
  5. width="30%"
  6. :before-close="handleClose">
  7. <span>这是一段信息</span>
  8. <template #footer>
  9. <span class="dialog-footer">
  10. <el-button @click="dialogVisible = false">取 消</el-button>
  11. <el-button type="primary" @click="dialogVisible = false">确 定</el-button>
  12. </span>
  13. </template>
  14. </el-dialog>
  15. <script>
  16. export default {
  17. data() {
  18. return {
  19. dialogVisible: false
  20. };
  21. },
  22. methods: {
  23. handleClose(done) {
  24. this.$confirm('确认关闭?')
  25. .then(_ => {
  26. done();
  27. })
  28. .catch(_ => {});
  29. }
  30. }
  31. };
  32. </script>

before-close 仅当用户通过点击关闭图标或遮罩关闭 Dialog 时起效。如果你在 footer 具名 slot 里添加了用于关闭 Dialog 的按钮,那么可以在按钮的点击回调函数里加入 before-close 的相关逻辑。

自定义内容

Dialog 组件的内容可以是任意的,甚至可以是表格或表单,下面是应用了 Element Plus Table 和 Form 组件的两个样例。

Dialog 对话框 - 图2

  1. <el-button type="text" @click="dialogTableVisible = true">打开嵌套表格的 Dialog</el-button>
  2. <el-dialog title="收货地址" v-model="dialogTableVisible">
  3. <el-table :data="gridData">
  4. <el-table-column property="date" label="日期" width="150"></el-table-column>
  5. <el-table-column property="name" label="姓名" width="200"></el-table-column>
  6. <el-table-column property="address" label="地址"></el-table-column>
  7. </el-table>
  8. </el-dialog>
  9. <!-- Form -->
  10. <el-button type="text" @click="dialogFormVisible = true">打开嵌套表单的 Dialog</el-button>
  11. <el-dialog title="收货地址" v-model="dialogFormVisible">
  12. <el-form :model="form">
  13. <el-form-item label="活动名称" :label-width="formLabelWidth">
  14. <el-input v-model="form.name" autocomplete="off"></el-input>
  15. </el-form-item>
  16. <el-form-item label="活动区域" :label-width="formLabelWidth">
  17. <el-select v-model="form.region" placeholder="请选择活动区域">
  18. <el-option label="区域一" value="shanghai"></el-option>
  19. <el-option label="区域二" value="beijing"></el-option>
  20. </el-select>
  21. </el-form-item>
  22. </el-form>
  23. <template #footer>
  24. <span class="dialog-footer">
  25. <el-button @click="dialogFormVisible = false">取 消</el-button>
  26. <el-button type="primary" @click="dialogFormVisible = false">确 定</el-button>
  27. </span>
  28. </template>
  29. </el-dialog>
  30. <script>
  31. export default {
  32. data() {
  33. return {
  34. gridData: [{
  35. date: '2016-05-02',
  36. name: '王小虎',
  37. address: '上海市普陀区金沙江路 1518 弄'
  38. }, {
  39. date: '2016-05-04',
  40. name: '王小虎',
  41. address: '上海市普陀区金沙江路 1518 弄'
  42. }, {
  43. date: '2016-05-01',
  44. name: '王小虎',
  45. address: '上海市普陀区金沙江路 1518 弄'
  46. }, {
  47. date: '2016-05-03',
  48. name: '王小虎',
  49. address: '上海市普陀区金沙江路 1518 弄'
  50. }],
  51. dialogTableVisible: false,
  52. dialogFormVisible: false,
  53. form: {
  54. name: '',
  55. region: '',
  56. date1: '',
  57. date2: '',
  58. delivery: false,
  59. type: [],
  60. resource: '',
  61. desc: ''
  62. },
  63. formLabelWidth: '120px'
  64. };
  65. }
  66. };
  67. </script>

嵌套的 Dialog

如果需要在一个 Dialog 内部嵌套另一个 Dialog,需要使用 append-to-body 属性。

Dialog 对话框 - 图3

正常情况下,我们不建议使用嵌套的 Dialog,如果需要在页面上同时显示多个 Dialog,可以将它们平级放置。对于确实需要嵌套 Dialog 的场景,我们提供了append-to-body属性。将内层 Dialog 的该属性设置为 true,它就会插入至 body 元素上,从而保证内外层 Dialog 和遮罩层级关系的正确。

  1. <template>
  2. <el-button type="text" @click="outerVisible = true">点击打开外层 Dialog</el-button>
  3. <el-dialog title="外层 Dialog" v-model="outerVisible">
  4. <el-dialog
  5. width="30%"
  6. title="内层 Dialog"
  7. v-model="innerVisible"
  8. append-to-body>
  9. </el-dialog>
  10. <template #footer>
  11. <div class="dialog-footer">
  12. <el-button @click="outerVisible = false">取 消</el-button>
  13. <el-button type="primary" @click="innerVisible = true">打开内层 Dialog</el-button>
  14. </div>
  15. </template>
  16. </el-dialog>
  17. </template>
  18. <script>
  19. export default {
  20. data() {
  21. return {
  22. outerVisible: false,
  23. innerVisible: false
  24. };
  25. }
  26. }
  27. </script>

居中布局

标题和底部可水平居中

Dialog 对话框 - 图4

center设置为true即可使标题和底部居中。center仅影响标题和底部区域。Dialog 的内容是任意的,在一些情况下,内容并不适合居中布局。如果需要内容也水平居中,请自行为其添加 CSS。

  1. <el-button type="text" @click="centerDialogVisible = true">点击打开 Dialog</el-button>
  2. <el-dialog
  3. title="提示"
  4. v-model="centerDialogVisible"
  5. width="30%"
  6. center>
  7. <span>需要注意的是内容是默认不居中的</span>
  8. <template #footer>
  9. <span class="dialog-footer">
  10. <el-button @click="centerDialogVisible = false">取 消</el-button>
  11. <el-button type="primary" @click="centerDialogVisible = false">确 定</el-button>
  12. </span>
  13. </template>
  14. </el-dialog>
  15. <script>
  16. export default {
  17. data() {
  18. return {
  19. centerDialogVisible: false
  20. };
  21. }
  22. };
  23. </script>

Dialog 的内容是懒渲染的,即在第一次被打开之前,传入的默认 slot 不会被渲染到 DOM 上。因此,如果需要执行 DOM 操作,或通过 ref 获取相应组件,请在 open 事件回调中进行。

如果 visible 属性绑定的变量位于 Vuex 的 store 内,那么 .sync 不会正常工作。此时需要去除 .sync 修饰符,同时监听 Dialog 的 openclose 事件,在事件回调中执行 Vuex 中对应的 mutation 更新 visible 属性绑定的变量的值。

Attributes

参数说明类型可选值默认值
model-value / v-model是否显示 Dialogboolean
titleDialog 的标题,也可通过具名 slot (见下表)传入string
widthDialog 的宽度string50%
fullscreen是否为全屏 Dialogbooleanfalse
topDialog CSS 中的 margin-top 值string15vh
modal是否需要遮罩层booleantrue
append-to-bodyDialog 自身是否插入至 body 元素上。嵌套的 Dialog 必须指定该属性并赋值为 truebooleanfalse
lock-scroll是否在 Dialog 出现时将 body 滚动锁定booleantrue
custom-classDialog 的自定义类名string
open-delayDialog 打开的延时时间,单位毫秒number0
close-delayDialog 关闭的延时时间,单位毫秒number0
close-on-click-modal是否可以通过点击 modal 关闭 Dialogbooleantrue
close-on-press-escape是否可以通过按下 ESC 关闭 Dialogbooleantrue
show-close是否显示关闭按钮booleantrue
before-close关闭前的回调,会暂停 Dialog 的关闭function(done),done 用于关闭 Dialog
center是否对头部和底部采用居中布局booleanfalse
destroy-on-close关闭时销毁 Dialog 中的元素booleanfalse

Slot

name说明
Dialog 的内容
titleDialog 标题区的内容
footerDialog 按钮操作区的内容

Events

事件名称说明回调参数
openDialog 打开的回调
openedDialog 打开动画结束时的回调
closeDialog 关闭的回调
closedDialog 关闭动画结束时的回调