vant/docs/markdown/en-US/dialog.md

Dialog

Install

import { Dialog } from 'vant';

Usage

Alert dialog

Used to prompt for some messages, only including one confirm button

Dialog.alert({
  title: 'Title',
  message: 'Content'
}).then(() => {
  // on close
});

Dialog.alert({
  message: 'Content'
}).then(() => {
  // on close
});

Confirm dialog

Used to confirm some messages, including a confirm button and a cancel button

 Dialog.confirm({
  title: 'Title',
  message: 'Content'
}).then(() => {
  // on confirm
}).catch(() => {
  // on cancel
});

$dialog Method

After import the Dialog component, the $dialog method is automatically mounted on Vue.prototype, making it easy to call within a vue component.

export default {
  mounted() {
    this.$dialog.alert({
      message: 'Content'
    });
  }
}

Methods

Name	Attribute	Return value	Description
Dialog	options	Promise	Show dialog
Dialog.alert	options	Promise	Show alert dialog
Dialog.confirm	options	Promise	Show confim dialog
Dialog.setDefaultOptions	options	void	Set default options of all dialogs
Dialog.resetDefaultOptions	-	void	Reset default options of all dialogs
Dialog.close	-	void	Close dialog

Options

Attribute	Description	Type	Default	Accepted Values
title	Title	String	-	-
message	Message	String	-	-
showConfirmButton	Whether to show confirm button	Boolean	true	-
showCancelButton	Whether to show cancel button	Boolean	false	-
confirmButtonText	Confirm button text	String	Confirm	-
cancelButtonText	Cancel button test	String	Cancel	-
overlay	Whether to show overlay	Boolean	true	-
closeOnClickOverlay	Whether to close when click overlay	Boolean	false	-
lockScroll	Whether to lock body scroll	Boolean	true	-
beforeClose	Callback before close，call done to close dialog	(action: string, done: function) => void	-	-

Advanced Usage

If you need to render vue components within a dialog, you can use dialog component.

<van-dialog v-model="show" :asyncConfirm="onClickConfirmAsync">
  <van-field
    v-model="username"
    label="Username"
    placeholder="Username"
  />
  <van-field
    v-model="password"
    type="password"
    :label="Password"
    :placeholder="Password"
  />
</van-dialog>

Vue.use(Dialog);

export default {
  data() {
    return {
      show: false,
      username: '',
      password: ''
    };
  },
  
  methods: {
    beforeClose() {
      if (action === 'confirm') {
        setTimeout(done, 1000);
      } else {
        done();
      }
    }
  }
}

API

Attribute	Description	Type	Default	Accepted Values
v-model	Whether to show dialog	Boolean	-	-
title	Title	String	-	-
message	Message	String	-	-
async-confirm	Whether to close async，The incoming function is triggered when you click confirm.	Function	-	-
show-confirm-button	Whether to show confirm button	Boolean	true	-
show-cancel-button	Whether to show cancel button	Boolean	false	-
confirm-button-text	Confirm button text	String	Confirm	-
cancel-button-text	Cancel button test	String	Cancel	-
overlay	Whether to show overlay	Boolean	true	-
close-on-click-overlay	Whether to close when click overlay	Boolean	false	-
lock-scroll	Whether to lock background scroll	Boolean	true	-
before-close	Callback before close，call done to close dialog	(action: string, done: function) => void	-	-

Event

Event	Description	Parameters
confirm	Triggered when click confirm button	-
cancel	Triggered when click cancel button	-