SwipeCell 滑动单元格

介绍

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

引入

import { createApp } from 'vue';
import { SwipeCell } from '@szhn/dh-design-mobile';

const app = createApp();
app.use(SwipeCell);

代码演示

基础用法

SwipeCell 组件提供了 left 和 right 两个插槽，用于定义两侧滑动区域的内容。

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

自定义内容

SwipeCell 内容可以自定义，不限于单元格组件。

<van-swipe-cell>
  <div style="padding: 16px;">
    <div style="font-size: 16px; margin-bottom: 4px;">标题</div>
    <div style="font-size: 14px; color: #999;">这是一段描述文字</div>
  </div>
  <template #right>
    <van-button square style="height: 100%;" type="danger" text="删除" />
  </template>
</van-swipe-cell>

异步关闭

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

<van-swipe-cell :before-close="beforeClose">
  <van-cell :border="false" title="单元格" value="内容" />
  <template #right>
    <van-button square type="danger" text="删除" />
  </template>
</van-swipe-cell>

const beforeClose = ({ position }) => {
  if (position === 'right') {
    return new Promise((resolve) => {
      resolve(true);
    });
  }
};

API

Props

参数	说明	类型	默认值
name	标识符，通常为一个唯一的字符串或数字，可以在事件参数中获取到	number | string	''
left-width	指定左侧滑动区域宽度，单位为 px	number | string	auto
right-width	指定右侧滑动区域宽度，单位为 px	number | string	auto
threshold	滑动触发阈值（滑动距离与滑动区域宽度的比例）	number | string	0.15
before-close	关闭前的回调函数，返回 false 可阻止关闭，支持返回 Promise	(args) => boolean | Promise<boolean>	-
disabled	是否禁用滑动	boolean	false
stop-propagation	是否阻止滑动事件冒泡	boolean	false

Slots

名称	说明
default	默认显示的内容
left	左侧滑动区域的内容
right	右侧滑动区域的内容

Events

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

beforeClose 参数

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

参数名	说明	类型
name	标识符	string | number
position	关闭时的点击位置	'left' | 'right' | 'cell' | 'outside'

方法

通过 ref 可以获取到 SwipeCell 实例并调用实例方法。

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