Popover 气泡弹出框

介绍

弹出式的气泡菜单。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Popover } from 'vant';
  3. const app = createApp();
  4. app.use(Popover);

代码演示

基础用法

当 Popover 弹出时,会基于 reference 插槽的内容进行定位。

  1. <van-popover v-model:show="showPopover" :actions="actions" @select="onSelect">
  2. <template #reference>
  3. <van-button type="primary">浅色风格</van-button>
  4. </template>
  5. </van-popover>
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  3. export default {
  4. setup() {
  5. const showPopover = ref(false);
  6. // 通过 actions 属性来定义菜单选项
  7. const actions = [
  8. { text: '选项一' },
  9. { text: '选项二' },
  10. { text: '选项三' },
  11. ];
  12. const onSelect = (action) => Toast(action.text);
  13. return {
  14. actions,
  15. onSelect,
  16. showPopover,
  17. };
  18. },
  19. };

深色风格

Popover 支持浅色和深色两种风格,默认为浅色风格,将 theme 属性设置为 dark 可切换为深色风格。

  1. <van-popover v-model:show="showPopover" theme="dark" :actions="actions">
  2. <template #reference>
  3. <van-button type="primary">深色风格</van-button>
  4. </template>
  5. </van-popover>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const showPopover = ref(false);
  5. const actions = [
  6. { text: '选项一' },
  7. { text: '选项二' },
  8. { text: '选项三' },
  9. ];
  10. return {
  11. actions,
  12. showPopover,
  13. };
  14. },
  15. };

弹出位置

通过 placement 属性来控制气泡的弹出位置。

  1. <van-popover placement="top" />

placement 支持以下值:

  1. top # 顶部中间位置
  2. top-start # 顶部左侧位置
  3. top-end # 顶部右侧位置
  4. left # 左侧中间位置
  5. left-start # 左侧上方位置
  6. left-end # 左侧下方位置
  7. right # 右侧中间位置
  8. right-start # 右侧上方位置
  9. right-end # 右侧下方位置
  10. bottom # 底部中间位置
  11. bottom-start # 底部左侧位置
  12. bottom-end # 底部右侧位置

展示图标

actions 数组中,可以通过 icon 字段来定义选项的图标,支持传入图标名称或图片链接。

  1. <van-popover v-model:show="showPopover" :actions="actions">
  2. <template #reference>
  3. <van-button type="primary">展示图标</van-button>
  4. </template>
  5. </van-popover>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const showPopover = ref(false);
  5. const actions = [
  6. { text: '选项一', icon: 'add-o' },
  7. { text: '选项二', icon: 'music-o' },
  8. { text: '选项三', icon: 'more-o' },
  9. ];
  10. return {
  11. actions,
  12. showPopover,
  13. };
  14. },
  15. };

禁用选项

actions 数组中,可以通过 disabled 字段来禁用某个选项。

  1. <van-popover v-model:show="showPopover" :actions="actions">
  2. <template #reference>
  3. <van-button type="primary">禁用选项</van-button>
  4. </template>
  5. </van-popover>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const showPopover = ref(false);
  5. const actions = [
  6. { text: '选项一', disabled: true },
  7. { text: '选项二', disabled: true },
  8. { text: '选项三' },
  9. ];
  10. return {
  11. actions,
  12. showPopover,
  13. };
  14. },
  15. };

自定义内容

通过默认插槽,可以在 Popover 内部放置任意内容。

  1. <van-popover v-model:show="showPopover">
  2. <van-grid
  3. square
  4. clickable
  5. :border="false"
  6. column-num="3"
  7. style="width: 240px;"
  8. >
  9. <van-grid-item
  10. v-for="i in 6"
  11. :key="i"
  12. text="选项"
  13. icon="photo-o"
  14. @click="showPopover = false"
  15. />
  16. </van-grid>
  17. <template #reference>
  18. <van-button type="primary">自定义内容</van-button>
  19. </template>
  20. </van-popover>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const showPopover = ref(false);
  5. return { showPopover };
  6. },
  7. };

API

Props

参数说明类型默认值
v-model:show是否展示气泡弹出层booleanfalse
actions选项列表PopoverAction[][]
placement弹出位置PopoverPlacementbottom
theme主题风格,可选值为 darkPopoverThemelight
trigger触发方式,可选值为 manualPopoverTriggerclick
duration动画时长,单位秒,设置为 0 可以禁用动画number | string0.3
offset出现位置的偏移量[number, number][0, 8]
overlay是否显示遮罩层booleanfalse
overlay-class v3.0.10自定义遮罩层类名string | Array | object-
overlay-style v3.0.10自定义遮罩层样式object-
show-arrow v3.2.2是否展示小箭头booleantrue
close-on-click-action是否在点击选项后关闭booleantrue
close-on-click-outside是否在点击外部元素后关闭菜单booleantrue
close-on-click-overlay v3.0.10是否在点击遮罩层后关闭菜单booleantrue
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Elementbody
icon-prefix v3.0.17图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon

PopoverAction 数据结构

actions 属性是一个由对象构成的数组,数组中的每个对象配置一列,对象可以包含以下值:

键名说明类型
text选项文字string
icon文字左侧的图标,支持传入图标名称或图片链接string
color选项文字颜色string
disabled是否为禁用状态boolean
className为对应选项添加额外的类名string | Array | object

Events

事件名说明回调参数
select点击选项时触发action: Action, index: number
open打开菜单时触发-
close关闭菜单时触发-
opened打开菜单且动画结束后触发-
closed关闭菜单且动画结束后触发-
click-overlay点击遮罩层时触发event: MouseEvent

Slots

名称说明
default自定义菜单内容
reference触发 Popover 显示的元素内容

类型定义

组件导出以下类型定义:

  1. import type {
  2. PopoverTheme,
  3. PopoverAction,
  4. PopoverTrigger,
  5. PopoverPlacement,
  6. } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-popover-arrow-size6px-
—van-popover-border-radiusvar(—van-border-radius-lg)-
—van-popover-action-width128px-
—van-popover-action-height44px-
—van-popover-action-font-sizevar(—van-font-size-md)-
—van-popover-action-line-heightvar(—van-line-height-md)-
—van-popover-action-icon-size20px-
—van-popover-light-text-colorvar(—van-text-color)-
—van-popover-light-background-colorvar(—van-white)-
—van-popover-light-action-disabled-text-colorvar(—van-gray-5)-
—van-popover-dark-text-colorvar(—van-white)-
—van-popover-dark-background-color#4a4a4a-
—van-popover-dark-action-disabled-text-colorvar(—van-gray-6)-

常见问题

Popover 的点击事件无法正确触发?

这种情况通常是由于项目中引入了 fastclick 库导致的。建议移除 fastclick,或者配置 fastclickignore 规则

Popover 气泡弹出框 - 图1