vant/packages/popup/zh-CN.md

Popup 弹出层

介绍

弹出层容器，用于展示弹窗、信息提示等内容，支持多个弹出层叠加展示

引入

import { Popup } from 'vant';

Vue.use(Popup);

代码演示

基础用法

通过v-model控制弹出层是否展示

<van-button type="primary" @click="showPopup">
  展示弹出层
</van-button>

<van-popup v-model="show">内容</van-popup>

export default {
  data() {
    return {
      show: false
    }
  },

  methods: {
    showPopup() {
      this.show = true;
    }
  }
};

弹出位置

通过position属性设置弹出位置，默认居中弹出，可以设置为top、bottom、left、right

<van-popup
  v-model="show"
  position="top"
  :style="{ height: '20%' }"
/>

指定挂载位置

弹出层默认挂载到组件所在位置，可以通过get-container属性指定挂载位置

<!-- 挂载到 body 节点下 -->
<van-popup
  v-model="show"
  get-container="body"
/>

<!-- 挂载到 #app 节点下 -->
<van-popup
  v-model="show"
  get-container="#app"
/>

<!-- 通过函数指定挂载位置 -->
<van-popup
  v-model="show"
  :get-container="getContainer"
/>

export default {
  methods: {
    // 返回一个特定的 DOM 节点，作为挂载的父节点
    getContainer() {
      return document.querySelector('.my-container');
    }
  }
}

API

Props

参数	说明	类型	默认值	版本
v-model	当前组件是否显示	Boolean	false	-
overlay	是否显示遮罩层	Boolean	true	-
position	位置，可选值为 top bottom right left	String	center	-
overlay-class	自定义遮罩层类名	String	-	-
overlay-style	自定义遮罩层样式	Object	-	-
transition	动画类名，用法与原生transtion组件的name属性一致	String	-	-
duration	动画时长，单位秒	Number	0.3	2.0.0
get-container	指定挂载的节点，可以传入选择器， 或一个返回节点的函数	`String	() => HTMLElement`	-
close-on-click-overlay	是否在点击遮罩层后关闭	Boolean	true	-
lock-scroll	是否锁定背景滚动	Boolean	true	1.0.0
lazy-render	是否在显示弹层时才渲染节点	Boolean	true	1.1.5

Events

事件名	说明	回调参数
click	点击弹出层时触发	-
open	打开弹出层时触发	-
opened	打开弹出层且动画结束后触发	-
close	关闭弹出层时触发	-
closed	关闭弹出层且动画结束后触发	-
click-overlay	点击遮罩层时触发	-