Dialog 弹出框

弹出框组件支持函数调用和组件调用两种方式。

函数调用

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

组件调用

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

  1. import { Dialog } from 'vant';
  2. // 全局注册
  3. Vue.use(Dialog);
  4. // 局部注册
  5. export default {
  6. [Dialog.Component.name]: Dialog.Component,
  7. },
  8. };

消息提示

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

  1. Dialog.alert({
  2. title: '标题',
  3. message: '弹窗内容',
  4. }).then(() => {
  5. // on close
  6. });
  7. Dialog.alert({
  8. message: '弹窗内容',
  9. }).then(() => {
  10. // on close
  11. });

消息确认

将 theme 选项设置为 round-button 可以展示圆角按钮风格的弹窗,该选项从 2.10.0 版本开始支持。

  1. Dialog.alert({
  2. title: '标题',
  3. message: '弹窗内容',
  4. theme: 'round-button',
  5. }).then(() => {
  6. // on close
  7. });
  8. Dialog.alert({
  9. message: '弹窗内容',
  10. }).then(() => {
  11. // on close
  12. });

异步关闭

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

  1. function beforeClose(action, done) {
  2. if (action === 'confirm') {
  3. setTimeout(done, 1000);
  4. } else {
  5. done();
  6. }
  7. }
  8. Dialog.confirm({
  9. title: '标题',
  10. message: '弹窗内容',
  11. beforeClose,
  12. });

全局方法

引入 Dialog 组件后,会自动在 Vue 的 prototype 上挂载 $dialog 方法,在所有组件内部都可以直接调用此方法。

组件调用

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

  1. <van-dialog v-model="show" title="标题" show-cancel-button>
  2. <img src="https://img01.yzcdn.cn/vant/apple-3.jpg" />
  3. </van-dialog>
  1. export default {
  2. data() {
  3. return {
  4. show: false,
  5. };
  6. },

API

方法

参数说明类型默认值
title标题string-
width弹窗宽度,默认单位为pxnumber | string320px
message文本内容,支持通过\n换行string-
messageAlign内容对齐方式,可选值为left rightstringcenter
theme样式风格,可选值为roundstringdefault
className自定义类名any-
showConfirmButton是否展示确认按钮booleantrue
showCancelButton是否展示取消按钮booleanfalse
confirmButtonText确认按钮文案string确认
confirmButtonColor确认按钮颜色string#ee0a24
cancelButtonText取消按钮文案string取消
cancelButtonColor取消按钮颜色stringblack
overlay是否展示遮罩层booleantrue
overlayClass自定义遮罩层类名string-
overlayStyle自定义遮罩层样式object-
closeOnPopstate是否在页面回退时自动关闭booleantrue
closeOnClickOverlay是否在点击遮罩层后关闭弹窗booleanfalse
lockScroll是否锁定背景滚动booleantrue
allowHtml v2.8.7是否允许 message 内容中渲染 HTMLboolean
beforeClose关闭前的回调函数,
调用 done() 后关闭弹窗,
调用 done(false) 阻止弹窗关闭
(action, done) => void-
transition动画类名,等价于 的name属性string-
getContainer指定挂载的节点,用法示例string | () => Elementbody

Props

通过组件调用 Dialog 时,支持以下 Props:

Events

通过组件调用 Dialog 时,支持以下事件:

事件说明回调参数
confirm点击确认按钮时触发-
cancel点击取消按钮时触发-
open打开弹窗时触发-
close关闭弹窗时触发-
opened打开弹窗且动画结束后触发-
closed关闭弹窗且动画结束后触发-

Slots

通过组件调用 Dialog 时,支持以下插槽:

样式变量

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

名称默认值描述
@dialog-width320px-
@dialog-small-screen-width90%-
@dialog-font-size@font-size-lg-
@dialog-transition@animation-duration-base-
@dialog-border-radius16px-
@dialog-background-color@white-
@dialog-header-font-weight@font-weight-bold-
@dialog-header-line-height24px-
@dialog-header-padding-top26px-
@dialog-header-isolated-padding@padding-lg 0-
@dialog-message-padding@padding-lg-
@dialog-message-font-size@font-size-md-
@dialog-message-line-height@line-height-md-
@dialog-message-max-height60vh-
@dialog-has-title-message-text-color@gray-7-
@dialog-has-title-message-padding-top@padding-xs-
@dialog-button-height48px-
@dialog-round-button-height36px-
@dialog-confirm-button-text-color@red-