Dialog 弹出框
函数调用
是一个函数,调用后会直接在页面中弹出相应的模态框。
组件调用
通过组件调用 Dialog 时,可以通过下面的方式进行注册:
import { createApp } from 'vue';
import { Dialog } from 'vant';
// 全局注册
const app = createApp();
app.use(Dialog);
// 局部注册
export default {
components: {
[Dialog.Component.name]: Dialog.Component,
},
};
在 script setup
中,可以通过以下方式使用:
<script setup>
const VanDialog = Dialog.Component;
</script>
<template>
<!-- 中划线命名 -->
<van-dialog />
<!-- 也支持大驼峰命名 -->
<VanDialog>
</template>
消息提示
用于提示一些消息,只包含一个确认按钮。
Dialog.alert({
title: '标题',
message: '代码是写出来给人看的,附带能在机器上运行。',
}).then(() => {
// on close
});
Dialog.alert({
message: '生命远不止连轴转和忙到极限,人类的体验远比这辽阔、丰富得多。',
}).then(() => {
// on close
});
消息确认
用于确认消息,包含取消和确认按钮。
圆角按钮风格
Dialog.alert({
title: '标题',
message: '代码是写出来给人看的,附带能在机器上运行。',
theme: 'round-button',
}).then(() => {
// on close
});
Dialog.alert({
message: '生命远不止连轴转和忙到极限,人类的体验远比这辽阔、丰富得多。',
theme: 'round-button',
}).then(() => {
// on close
});
通过 beforeClose
属性可以传入一个回调函数,在弹窗关闭前进行特定操作。
new Promise((resolve) => {
setTimeout(() => {
if (action === 'confirm') {
resolve(true);
} else {
resolve(false);
}
}, 1000);
});
Dialog.confirm({
title: '标题',
message:
'如果解决方法是丑陋的,那就肯定还有更好的解决方法,只是还没有发现而已。',
beforeClose,
});
全局方法
通过 app.use
全局注册 Dialog 组件后,会自动在 app 的所有子组件上挂载 $dialog
方法,在所有组件内部都可以直接调用此方法。
export default {
mounted() {
this.$dialog.alert({
message: '弹窗内容',
});
},
};
组件调用
如果需要在弹窗内嵌入组件或其他自定义内容,可以使用组件调用的方式。
import { ref } from 'vue';
export default {
setup() {
const show = ref(false);
return { show };
},
};
方法
DialogOptions
通过函数调用 Dialog
时,支持传入以下选项:
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
title | 标题 | string | - |
width | 弹窗宽度,默认单位为 px | number | string | 320px |
message | 文本内容,支持通过 \n 换行 | string | () => JSX.ELement | - |
messageAlign | 内容对齐方式,可选值为 left right | string | center |
theme | 样式风格,可选值为 round-button | string | default |
className | 自定义类名 | string | Array | object | - |
showConfirmButton | 是否展示确认按钮 | boolean | true |
showCancelButton | 是否展示取消按钮 | boolean | false |
confirmButtonText | 确认按钮文案 | string | 确认 |
confirmButtonColor | 确认按钮颜色 | string | |
cancelButtonText | 取消按钮文案 | string | 取消 |
cancelButtonColor | 取消按钮颜色 | string | black |
overlay | 是否展示遮罩层 | boolean | true |
overlayClass | 自定义遮罩层类名 | string | Array | object | - |
overlayStyle | 自定义遮罩层样式 | object | - |
closeOnPopstate | 是否在页面回退时自动关闭 | boolean | true |
closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | boolean | false |
lockScroll | 是否锁定背景滚动 | boolean | true |
allowHtml | 是否允许 message 内容中渲染 HTML | boolean | false |
beforeClose | 关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise | (action: string) => boolean | Promise<boolean> | - |
transition | 动画类名,等价于 transition 的 name 属性 | string | - |
teleport | 指定挂载的节点,等同于 Teleport 组件的 | string | Element | body |
Props
通过组件调用 Dialog
时,支持以下事件:
事件 | 说明 | 回调参数 |
---|---|---|
confirm | 点击确认按钮时触发 | - |
cancel | 点击取消按钮时触发 | - |
open | 打开弹窗时触发 | - |
close | 关闭弹窗时触发 | - |
opened | 打开弹窗且动画结束后触发 | - |
closed | 关闭弹窗且动画结束后触发 | - |
Slots
通过组件调用 Dialog
时,支持以下插槽:
类型定义
组件导出以下类型定义:
import type {
DialogProps,
DialogTheme,
DialogMessage,
DialogOptions,
DialogMessageAlign,
} from 'vant';
样式变量
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
—van-dialog-width | 320px | - |
—van-dialog-small-screen-width | 90% | - |
—van-dialog-font-size | var(—van-font-size-lg) | - |
—van-dialog-transition | var(—van-animation-duration-base) | - |
—van-dialog-border-radius | 16px | - |
—van-dialog-background-color | var(—van-background-color-light) | - |
—van-dialog-header-font-weight | var(—van-font-weight-bold) | - |
—van-dialog-header-line-height | 24px | - |
—van-dialog-header-padding-top | 26px | - |
—van-dialog-header-isolated-padding | var(—van-padding-lg) 0 | - |
—van-dialog-message-padding | var(—van-padding-lg) | - |
—van-dialog-message-font-size | var(—van-font-size-md) | - |
—van-dialog-message-line-height | var(—van-line-height-md) | - |
—van-dialog-message-max-height | 60vh | - |
—van-dialog-has-title-message-text-color | var(—van-gray-7) | - |
—van-dialog-has-title-message-padding-top | var(—van-padding-xs) | - |
—van-dialog-button-height | 48px | - |
—van-dialog-round-button-height | 36px | - |
—van-dialog-confirm-button-text-color | var(—van-danger-color) | - |
在 beforeRouteLeave 里调用 Dialog 无法展示?
将 closeOnPopstate
属性设置为 false 即可。
Dialog.alert({
title: '标题',
message: '弹窗内容',
closeOnPopstate: false,
}).then(() => {
});