vant/packages/popup/en-US.md

Popup

Install

import { Popup } from 'vant';

Vue.use(Popup);

Usage

Basic Usage

Popup is located in the middle of the screen by default

<van-popup v-model="show">Content</van-popup>

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

Position

Use position prop to set popup display position

<van-popup v-model="show" position="top" :overlay="false">
  Content
</van-popup>

API

Attribute	Description	Type	Default
v-model	Whether to show popup	Boolean	false
overlay	Whether to show overlay	Boolean	true
position	Can be set to top bottom right left	String	-
overlay-class	Custom overlay class	String	-
overlay-style	Custom overlay style	Object	-
close-on-click-overlay	Close popup when click overlay	Boolean	true
transition	Transition	String	popup-slide
lock-scroll	Whether to lock background scroll	Boolean	true
lazy-render	Whether to lazy render util appeared	Boolean	true
get-container	Return the mount node for Popup	`String	() => HTMLElement`

Event

Event	Description	Arguments
open	Triggered when open Popup	-
opened	Triggered when opened Popup	-
close	Triggered when close Popup	-
closed	Triggered when closed Popup	-
click-overlay	Triggered when click overlay	-