vant/src/overlay/README.md

Overlay

Install

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

Vue.use(Overlay);

Usage

Basic Usage

<van-button
  type="primary"
  text="Show Overlay"
  @click="show = true"
/>

<van-overlay
  :show="show"
  @click="show = false"
/>

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

API

Props

Attribute	Description	Type	Default	Version
show	Whether to show overlay	boolean	false	-
z-index	z-index	`number	string`	1
duration	Animation duration	`number	string`	0.3
class-name	ClassName	string	-	-

Events

Event	Description	Arguments
click	Triggered when clicked	event: Event