1.0.1 • Published 3 years ago

@ophiuchus/popover v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Popover 气泡弹出框

介绍

弹出式的气泡菜单。

引入

import Vue from 'vue';
import Popover from '@ophiuchus/popover';

Vue.use(Popover);

代码演示

基础用法

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

<sf-popover
  v-model="showPopover"
  trigger="click"
  :actions="actions"
  @select="onSelect"
>
  <template #reference>
    <sf-button type="primary">浅色风格</sf-button>
  </template>
</sf-popover>
import Toast  from '@ophiuchus/toast';

export default {
  data() {
    return {
      showPopover: false,
      // 通过 actions 属性来定义菜单选项
      actions: [{ text: '选项一' }, { text: '选项二' }, { text: '选项三' }],
    };
  },
  methods: {
    onSelect(action) {
      Toast(action.text);
    },
  },
};

深色风格

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

<sf-popover
  v-model="showPopover"
  theme="dark"
  trigger="click"
  :actions="actions"
>
  <template #reference>
    <sf-button type="primary">深色风格</sf-button>
  </template>
</sf-popover>
export default {
  data() {
    return {
      showPopover: false,
      actions: [{ text: '选项一' }, { text: '选项二' }, { text: '选项三' }],
    };
  },
};

弹出位置

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

<sf-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 字段来定义选项的图标,支持传入图标名称或图片链接。

<sf-popover v-model="showPopover" trigger="click" :actions="actions">
  <template #reference>
    <sf-button type="primary">展示图标</sf-button>
  </template>
</sf-popover>
export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: '选项一', icon: 'add-o' },
        { text: '选项二', icon: 'music-o' },
        { text: '选项三', icon: 'more-o' },
      ],
    };
  },
};

禁用选项

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

<sf-popover v-model="showPopover" trigger="click" :actions="actions">
  <template #reference>
    <sf-button type="primary">禁用选项</sf-button>
  </template>
</sf-popover>
export default {
  data() {
    return {
      showPopover: false,
      actions: [
        { text: '选项一', disabled: true },
        { text: '选项二', disabled: true },
        { text: '选项三' },
      ],
    };
  },
};

自定义内容

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

<sf-popover v-model="showPopover" trigger="click">
  <sf-grid
    square
    clickable
    :border="false"
    column-num="3"
    style="width: 240px;"
  >
    <sf-grid-item
      v-for="i in 6"
      :key="i"
      text="选项"
      icon="photo-o"
      @click="showPopover = false"
    />
  </sf-grid>
  <template #reference>
    <sf-button type="primary">自定义内容</sf-button>
  </template>
</sf-popover>
export default {
  data() {
    return {
      showPopover: false,
    };
  },
};

API

Props

参数说明类型默认值
v-model是否展示气泡弹出层booleanfalse
actions选项列表Action[][]
placement弹出位置stringbottom
theme主题风格,可选值为 darkstringlight
trigger触发方式,可选值为 click-
offset出现位置的偏移量number, number[0, 8]
overlay是否显示遮罩层booleanfalse
close-on-click-action是否在点击选项后关闭booleantrue
close-on-click-outside是否在点击外部元素后关闭菜单booleantrue
get-container指定挂载的节点,用法示例string | () => Elementbody

Action 数据结构

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

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

Events

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

Slots

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

样式变量

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

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

常见问题

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

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