Dialog 弹出框

Dialog 组件支持函数调用和组件调用两种形式

使用指南

  1. import { Dialog } from 'vant';
  2. Vue.use(Dialog);

代码演示

消息提示

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

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

消息确认

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

  1. Dialog.confirm({
  2. title: '标题',
  3. message: '弹窗内容'
  4. }).then(() => {
  5. // on confirm
  6. }).catch(() => {
  7. // on cancel
  8. });

全局方法

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

  1. export default {
  2. mounted() {
  3. this.$dialog.alert({
  4. message: '弹窗内容'
  5. });
  6. }
  7. }

方法

方法名参数返回值介绍
DialogoptionsPromise展示弹窗
Dialog.alertoptionsPromise展示消息提示弹窗
Dialog.confirmoptionsPromise展示消息确认弹窗
Dialog.setDefaultOptionsoptionsvoid修改默认配置,对所有 Dialog 生效
Dialog.resetDefaultOptions-void重置默认配置,对所有 Dialog 生效
Dialog.close-void关闭弹窗

Options

参数说明类型默认值版本
title标题String--
message内容String--
messageAlign内容对齐方式,可选值为left rightStringcenter1.5.0
className自定义类名String | Array | Object-1.1.7
showConfirmButton是否展示确认按钮Booleantrue-
showCancelButton是否展示取消按钮Booleanfalse-
confirmButtonText确认按钮的文案String确认-
cancelButtonText取消按钮的文案String取消-
overlay是否展示蒙层Booleantrue-
closeOnClickOverlay点击蒙层时是否关闭弹窗Booleanfalse-
lockScroll是否锁定背景滚动Booleantrue-
beforeClose关闭前的回调函数,调用 done() 后关闭弹窗,调用 done(false) 阻止弹窗关闭(action, done) => void-1.1.6

高级用法

如果需要在弹窗内实现更复杂的交互,可以通过组件形式来调用 Dialog,调用前需要通过 Vue.use 注册组件

  1. <van-dialog
  2. v-model="show"
  3. show-cancel-button
  4. :before-close="beforeClose"
  5. >
  6. <van-field
  7. v-model="username"
  8. label="用户名"
  9. placeholder="请输入用户名"
  10. />
  11. <van-field
  12. v-model="password"
  13. type="password"
  14. label="密码"
  15. placeholder="请输入密码"
  16. />
  17. </van-dialog>
  1. export default {
  2. data() {
  3. return {
  4. show: false,
  5. username: '',
  6. password: ''
  7. };
  8. },
  9. methods: {
  10. beforeClose(action, done) {
  11. if (action === 'confirm') {
  12. setTimeout(done, 1000);
  13. } else {
  14. done();
  15. }
  16. }
  17. }
  18. }

API

参数说明类型默认值版本
v-model是否显示弹窗Boolean--
title标题String--
message内容String--
message-align内容对齐方式,可选值为left rightStringcenter1.5.0
show-confirm-button是否展示确认按钮Booleantrue-
show-cancel-button是否展示取消按钮Booleanfalse-
confirm-button-text确认按钮的文案String确认-
cancel-button-text取消按钮的文案String取消-
overlay是否展示蒙层Booleantrue-
close-on-click-overlay是否在点击蒙层后关闭Booleanfalse-
lock-scroll是否锁定背景滚动Booleantrue-
before-close关闭前的回调函数,调用 done() 后关闭弹窗,调用 done(false) 阻止弹窗关闭(action, done) => void-1.1.6
get-container指定挂载的节点,可以传入选择器,或一个返回节点的函数String | () => HTMLElement-1.1.6

Event

事件说明回调参数
confirm点击确认按钮时触发-
cancel点击取消按钮时触发-

原文: https://youzan.github.io/vant/#/zh-CN/dialog