Dialog 弹出框

函数调用

是一个函数，调用后会直接在页面中弹出相应的模态框。

手动引入样式

Dialog 组件是以函数形式提供的，如果项目中使用 unplugin-vue-components 插件来自动引入组件样式，则无法正确识别 Dialog 组件，因此需要手动引入 Dialog 组件的样式：

import 'vant/es/dialog/style';

你可以在项目的入口文件或公共模块中引入 Dialog 组件的样式，这样在业务代码中使用 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 中，可以通过以下方式使用：

  const VanDialog = Dialog.Component;
</script>
<template>
  <!-- 中划线命名 -->
  <van-dialog />
  <!-- 也支持大驼峰命名 -->
  <VanDialog>
</template>

消息提示

用于提示一些消息，只包含一个确认按钮。

消息确认

Dialog.confirm({
  title: '标题',
  message:
    '如果解决方法是丑陋的，那就肯定还有更好的解决方法，只是还没有发现而已。',
})
  .then(() => {
    // on confirm
  })
  .catch(() => {
    // on cancel
  });

圆角按钮风格

将 theme 选项设置为 round-button 可以展示圆角按钮风格的弹窗。

Dialog.alert({
  title: '标题',
  message: '代码是写出来给人看的，附带能在机器上运行。',
  theme: 'round-button',
}).then(() => {
  // on close
});
Dialog.alert({
  message: '生命远不止连轴转和忙到极限，人类的体验远比这辽阔、丰富得多。',
  theme: 'round-button',
}).then(() => {
  // on close
});

通过 beforeClose 属性可以传入一个回调函数，在弹窗关闭前进行特定操作。

const beforeClose = (action) =>
    setTimeout(() => {
        resolve(true);
      } else {
        // 拦截取消操作
        resolve(false);
      }
    }, 1000);
  });
Dialog.confirm({
  title: '标题',
  message:
    '如果解决方法是丑陋的，那就肯定还有更好的解决方法，只是还没有发现而已。',
  beforeClose,
});

全局方法

通过 app.use 全局注册 Dialog 组件后，会自动在 app 的所有子组件上挂载 $dialog 方法，在所有组件内部都可以直接调用此方法。

组件调用

如果需要在弹窗内嵌入组件或其他自定义内容，可以使用组件调用的方式。

<van-dialog v-model:show="show" title="标题" show-cancel-button>
  <img src="https://fastly.jsdelivr.net/npm/@vant/assets/apple-3.jpeg" />
</van-dialog>

import { ref } from 'vue';
export default {
  setup() {
    const show = ref(false);
    return { show };
  },
};

方法

DialogOptions

通过函数调用 Dialog 时，支持传入以下选项：

Props

通过组件调用 Dialog 时，支持以下事件：

Slots

通过组件调用 Dialog 时，支持以下插槽：

类型定义

组件导出以下类型定义：

import type {
  DialogProps,
  DialogTheme,
  DialogMessage,
  DialogOptions,
  DialogMessageAlign,
} from 'vant';

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 。

在 beforeRouteLeave 里调用 Dialog 无法展示？

将 closeOnPopstate 属性设置为 false 即可。

在 JSX 中渲染 Dialog 组件无法展示？

请注意 Dialog 是一个函数，Dialog.Component 才是 Dialog 对应的组件。JSX 调用弹窗的正确姿势如下：

export default {
  setup() {
    const show = ref(false);
    return () => <Dialog.Component v-model={[show, 'show']} />;
  },