-

介绍

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

引入

import Vue from 'vue';
import { Popup } from 'vant';

Vue.use(Popup);

代码演示

基础用法

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

<van-cell is-link @click="showPopup">展示弹出层</van-cell>
<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%' }"
/>

关闭图标

设置closeable属性后,会在弹出层的右上角显示关闭图标,并且可以通过close-icon属性自定义图标,使用close-icon-position属性可以自定义图标位置

<van-popup
  v-model="show"
  closeable
  position="bottom"
  :style="{ height: '20%' }"
/>
<!-- 自定义图标 -->
<van-popup
  v-model="show"
  closeable
  close-icon="close"
  position="bottom"
  :style="{ height: '20%' }"
/>
<!-- 图标位置 -->
<van-popup
  v-model="show"
  closeable
  close-icon-position="top-left"
  position="bottom"
  :style="{ height: '20%' }"
/>

圆角弹窗

设置round属性后,弹窗会根据弹出位置添加不同的圆角样式

<van-popup
  v-model="show"
  round
  position="bottom"
  :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');
    }
  }
}
注意:使用 get-container 属性的组件不能为根节点

API

Props

参数说明类型默认值
v-model当前组件是否显示booleanfalse
overlay是否显示遮罩层booleantrue
position弹出位置,可选值为 top bottom right leftstringcenter
overlay-class自定义遮罩层类名string-
overlay-style自定义遮罩层样式object-
duration动画时长,单位秒number | string0.3
round v2.0.7是否显示圆角booleanfalse
lock-scroll是否锁定背景滚动booleantrue
lazy-render是否在显示弹层时才渲染节点booleantrue
close-on-popstate v2.2.10是否在页面回退时自动关闭booleanfalse
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
closeable v2.2.0是否显示关闭图标booleanfalse
close-icon v2.2.0关闭图标名称或图片链接stringcross
close-icon-position v2.2.2关闭图标位置,可选值为top-left
bottom-left bottom-right
stringtop-right
transition动画类名,等价于 transtion 的name属性string-
get-container指定挂载的节点string | () => Element-
safe-area-inset-bottom v2.2.1是否开启 底部安全区适配booleanfalse

Events

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


实例演示