vant/src/popover

Popover

Install

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

Vue.use(Popover);

Usage

Basic Usage

<van-popover v-model="showPopover" :actions="actions" @select="onSelect">
  <template #reference>
    <van-button type="primary" @click="showPopover = true">
      Light Theme
    </van-button>
  </template>
</van-popover>

import { Toast } from 'vant';

export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: 'Option 1' },
        { text: 'Option 2' },
        { text: 'Option 3' },
      ],
    };
  },
  methods: {
    onSelect(action) {
      Toast(action.text);
    },
  },
};

Dark theme

Using the theme prop to change the style of Popover.

<van-popover v-model="showPopover" theme="dark" :actions="actions">
  <template #reference>
    <van-button type="primary" @click="showPopover = true">
      Dark Theme
    </van-button>
  </template>
</van-popover>

export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: 'Option 1' },
        { text: 'Option 2' },
        { text: 'Option 3' },
      ],
    };
  },
};

Placement

<van-popover placement="top" />

placement supports the following values:

top           # Top middle
top-start     # Top left
top-end       # Top right
left          # Left middle
left-start    # Left top
left-end      # Left bottom
right         # Right middle
right-start   # Right top
right-end     # Right bottom
bottom        # Bottom middle
bottom-start  # Bottom left
bottom-end    # Bottom right

Show Icon

<van-popover v-model="showPopover" :actions="actions">
  <template #reference>
    <van-button type="primary" @click="showPopover = true">
      Show Icon
    </van-button>
  </template>
</van-popover>

export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: 'Option 1', icon: 'add-o' },
        { text: 'Option 2', icon: 'music-o' },
        { text: 'Option 3', icon: 'more-o' },
      ],
    };
  },
};

Disable Action

Using the disabled option to disable an action.

<van-popover v-model="showPopover" :actions="actions">
  <template #reference>
    <van-button type="primary" @click="showPopover = true">
      Disable Action
    </van-button>
  </template>
</van-popover>

export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: 'Option 1', disabled: true },
        { text: 'Option 2', disabled: true },
        { text: 'Option 3' },
      ],
    };
  },
};

API

Props

Attribute	Description	Type	Default
v-model	Whether to show Popover	boolean	false
actions	Actions	Action[]	[]
placement	Placement	string	bottom
theme	Theme，can be set to dark	string	light
offset	Distance to reference	[number, number]	[0, 8]
overlay	Whether to show overlay	boolean	false
close-on-click-action	Whether to close when clicking action	boolean	true
close-on-click-outside	Whether to close when clicking outside	boolean	true
get-container	Return the mount node for Popover	string | () => Element	body

Data Structure of Action

Key	Description	Type
text	Action Text	string
icon	Icon	string
disabled	Whether to be disabled	boolean
className	className of the option	any

Events

Event	Description	Arguments
select	Emitted when an action is clicked	action: Action, index: number
open	Emitted when opening Popover	-
close	Emitted when closing Popover	-
opened	Emitted when Popover is opened	-
closed	Emitted when Popover is closed	-

Slots

Name	Description
default	Custom content
reference	Reference Element