Vant3 Dialog 弹出框

Dialog 弹出框

介绍

弹出模态框，常用于消息提示、消息确认，或在当前页面内完成特定的交互操作，支持函数调用和组件调用两种方式。

实例演示

函数调用

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

import { Dialog } from vant;

Dialog({ message: 提示 });

组件调用

通过组件调用 Dialog 时，可以通过下面的方式进行注册：

import { createApp } from vue;
import { Dialog } from vant;

// 全局注册
const app = createApp();
app.use(Dialog);

// 局部注册
export default {
  components: {
    [Dialog.Component.name]: Dialog.Component,
  },
};

代码演示

消息提示

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

Dialog.alert({
  title: 标题,
  message: 弹窗内容,
}).then(() => {
  // on close
});

Dialog.alert({
  message: 弹窗内容,
}).then(() => {
  // on close
});

消息确认

用于确认消息，包含取消和确认按钮。

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) =>
  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: 弹窗内容,
    });
  },
};

Tips: 由于 setup 选项中无法访问 this，因此不能使用上述方式，请通过 import 引入。

组件调用

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

<van-dialog v-model:show="show" title="标题" show-cancel-button>
  <img src="https://img.yzcdn.cn/vant/apple-3.jpg" rel="external nofollow"  />
</van-dialog>

import { ref } from vue;

export default {
  setup() {
    const show = ref(false);
    return { show };
  },
};

API

方法

DialogOptions

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

Props

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

Events

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

Slots

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

样式变量

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

常见问题

在 beforeRouteLeave 里调用 Dialog 无法展示？

将 closeOnPopstate 属性设置为 false 即可。

Dialog.alert({
  title: 标题,
  message: 弹窗内容,
  closeOnPopstate: false,
}).then(() => {
  // on close
});

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

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

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