1.0.1 • Published 3 years ago

@ophiuchus/swipe-cell v1.0.1

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

SwipeCell 滑动单元格

介绍

可以左右滑动来展示操作按钮的单元格组件。

引入

import Vue from 'vue';
import SwipeCell from '@ophiuchus/swipe-cell';

Vue.use(SwipeCell);

代码演示

基础用法

SwipeCell 组件提供了 leftright 两个插槽,用于定义两侧滑动区域的内容。

<sf-swipe-cell>
  <template #left>
    <sf-button square type="primary" text="选择" />
  </template>
  <sf-cell :border="false" title="单元格" value="内容" />
  <template #right>
    <sf-button square type="danger" text="删除" />
    <sf-button square type="primary" text="收藏" />
  </template>
</sf-swipe-cell>

自定义内容

SwipeCell 可以嵌套任意内容,比如嵌套一个Cell 。

<sf-swipe-cell>
  <sf-cell-group inset>
    <sf-cell title="单元格" value="内容" />
    <sf-cell title="单元格" value="内容" label="描述信息" />
  </sf-cell-group>
  <template #right>
    <sf-button square text="删除" type="danger" class="delete-button" />
  </template>
</sf-swipe-cell>

<style>
  .goods-card {
    margin: 0;
    background-color: @white;
  }

  .delete-button {
    height: 100%;
  }
</style>

异步关闭

通过传入 before-close 回调函数,可以自定义两侧滑动内容关闭时的行为。

<sf-swipe-cell :before-close="beforeClose">
  <template #left>
    <sf-button square type="primary" text="选择" />
  </template>
  <sf-cell :border="false" title="单元格" value="内容" />
  <template #right>
    <sf-button square type="danger" text="删除" />
  </template>
</sf-swipe-cell>
export default {
  methods: {
    // position 为关闭时点击的位置
    // instance 为对应的 SwipeCell 实例
    beforeClose({ position, instance }) {
      switch (position) {
        case 'left':
        case 'cell':
        case 'outside':
          instance.close();
          break;
        case 'right':
          Dialog.confirm({
            message: '确定删除吗?',
          }).then(() => {
            instance.close();
          });
          break;
      }
    },
  },
};

API

Props

参数说明类型默认值
name标识符,可以在事件参数中获取到number | string-
left-width指定左侧滑动区域宽度,单位为pxnumber | stringauto
right-width指定右侧滑动区域宽度,单位为pxnumber | stringauto
before-close关闭前的回调函数Function-
disabled是否禁用滑动booleanfalse
stop-propagation是否阻止滑动事件冒泡booleanfalse

Slots

名称说明
default自定义显示内容
left左侧滑动内容
right右侧滑动内容

Events

事件名说明回调参数
click点击时触发关闭时的点击位置 (left right cell outside)
open打开时触发{ position: 'left' | 'right' , name: string }
close关闭时触发{ position: string , name: string }

beforeClose 参数

beforeClose 的第一个参数为对象,对象中包含以下属性:

参数名说明类型
name标识符string
position关闭时的点击位置 (left right cell outside)string
instanceSwipeCell 实例,用于调用实例方法SwipeCell

方法

通过 ref 可以获取到 SwipeCell 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
open打开单元格侧边栏position: left \| right-
close收起单元格侧边栏--

样式变量

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

名称默认值描述
@switch-cell-padding-top@cell-vertical-padding - 1px-
@switch-cell-padding-bottom@cell-vertical-padding - 1px-
@switch-cell-large-padding-top@cell-large-vertical-padding - 1px-
@switch-cell-large-padding-bottom@cell-large-vertical-padding - 1px-

常见问题

在桌面端无法操作组件?

参见桌面端适配