Popover 气泡弹出框

介绍

弹出式的气泡菜单。

代码演示

基础用法

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

<z-popover
  v-model:show="showPopover"
  :actions="actions"
  placement="bottom-start"
  @select="onSelect"
>
  <template #reference>
    <z-button type="primary"> 浅色风格 </z-button>
  </template>
</z-popover>
import { ref } from 'vue';
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const showPopover = ref(false);
// 通过 actions 属性来定义菜单选项
const actions = [
  { text: '选项一' },
  { text: '选项二' },
  { text: '选项三' },
];
const onSelect = (action) => toast.showToast(action.text);

深色风格

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

<z-popover v-model:show="showPopover" theme="dark" :actions="actions">
  <template #reference>
    <z-button type="primary">深色风格</z-button>
  </template>
</z-popover>
import { ref } from 'vue';
const showPopover = ref(false);
const actions = [
  { text: '选项一' },
  { text: '选项二' },
  { text: '选项三' },
];

水平排列

actions-direction 属性设置为 horizontal 后,菜单选项会变成水平排列。

<z-popover
  v-model:show="showPopover"
  :actions="actions"
  actions-direction="horizontal"
>
  <template #reference>
    <z-button type="primary">水平排列</z-button>
  </template>
</z-popover>
import { ref } from 'vue';
const showPopover = ref(false);
const actions = [
  { text: '选项一' },
  { text: '选项二' },
  { text: '选项三' },
];

弹出位置

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

<z-popover placement="top" />

placement 支持以下值:

top           # 顶部中间位置
top-start     # 顶部左侧位置
top-end       # 顶部右侧位置
left          # 左侧中间位置
left-start    # 左侧上方位置
left-end      # 左侧下方位置
right         # 右侧中间位置
right-start   # 右侧上方位置
right-end     # 右侧下方位置
bottom        # 底部中间位置
bottom-start  # 底部左侧位置
bottom-end    # 底部右侧位置

展示图标

actions 数组中,可以通过 icon 字段来定义选项的图标,支持传入图标名称或图片链接,等同于 Icon 组件的 name 属性

<z-popover v-model:show="showPopover" :actions="actions">
  <template #reference>
    <z-button type="primary">展示图标</z-button>
  </template>
</z-popover>
import { ref } from 'vue';
const showPopover = ref(false);
const actions = [
  { text: '选项一', icon: 'plus-circle' },
  { text: '选项二', icon: 'minus-circle' },
  { text: '选项三', icon: 'message' }
];

禁用选项

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

<z-popover v-model:show="showPopover" :actions="actions">
  <template #reference>
    <z-button type="primary">禁用选项</z-button>
  </template>
</z-popover>
import { ref } from 'vue';
const showPopover = ref(false);
const actions = [
  { text: '选项一', disabled: true },
  { text: '选项二', disabled: true },
  { text: '选项三' },
];

自定义内容

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

<z-popover
  v-model:show="show.customContent"
  placement="top-start"
  @select="onSelect"
>
  <z-grid
    square
    clickable
    :border="false"
    column-num="3"
    :custom-style="{ width: '480rpx' }"
  >
    <z-grid-item
      v-for="i in 6"
      :key="i"
      icon="image"
      text="选项"
      @click="show.customContent = false"
    />
  </z-grid>
  <template #reference>
    <z-button type="primary"> 自定义内容 </z-button>
  </template>
</z-popover>
import { ref } from 'vue';
const showPopover = ref(false);

非受控模式

你可以把 Popover 当做受控组件或非受控组件使用:

  • 当绑定 v-model:show 时,Popover 为受控组件,此时组件的显示完全由 v-model:show 的值决定。
  • 当未绑定 v-model:show 时,Popover 为非受控组件,此时你可以通过 show 属性传入一个默认值,组件值的显示由组件自身控制。
<z-popover :actions="actions" position="top-start" @select="onSelect">
  <template #reference>
    <z-button type="primary">非受控模式</z-button>
  </template>
</z-popover>
import { ref } from 'vue';
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const actions = [
  { text: '选项一' },
  { text: '选项二' },
  { text: '选项三' },
];
const onSelect = (action) => toast.showToast(action.text);

API

Props

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

PopoverAction 数据结构

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

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

Events

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

Slots

名称说明参数
default自定义菜单内容-
reference触发 Popover 显示的元素内容-
action自定义选项内容{ action: PopoverAction, index: number }

主题定制

样式变量

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

名称默认值描述
--z-popover-arrow-size12rpx-
--z-popover-radiusvar(--z-radius-lg)-
--z-popover-action-width256rpx-
--z-popover-action-height88rpx-
--z-popover-action-font-sizevar(--z-font-size-md)-
--z-popover-action-line-heightvar(--z-line-height-md)-
--z-popover-action-icon-size40rpx-
--z-popover-horizontal-action-height68rpx-
--z-popover-horizontal-action-icon-size32rpx-
--z-popover-light-text-colorvar(--z-text-color)-
--z-popover-light-backgroundvar(--z-background-2)-
--z-popover-light-action-disabled-text-colorvar(--z-text-color-3)-
--z-popover-dark-text-colorvar(--z-white)-
--z-popover-dark-background#4a4a4a-
--z-popover-dark-action-disabled-text-colorvar(--z-text-color-2)-