SwipeCell 滑动单元格

介绍

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

引入

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

代码演示

基础用法

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

  1. <van-swipe-cell>
  2.   <template #left>
  3.     <van-button square type="primary" text="选择" />
  4.   </template>
  5.   <van-cell :border="false" title="单元格" value="内容" />
  6.   <template #right>
  7.     <van-button square type="danger" text="删除" />
  8.     <van-button square type="primary" text="收藏" />
  9.   </template>
  10. </van-swipe-cell>

自定义内容

SwipeCell 可以嵌套任意内容，比如嵌套一个商品卡片。

  1. <van-swipe-cell>
  2.   <van-card
  3.     num="2"
  4.     price="2.00"
  5.     desc="描述信息"
  6.     title="商品标题"
  7.     class="goods-card"
  8.     thumb="https://img.yzcdn.cn/vant/cat.jpeg"
  9.   />
  10.   <template #right>
  11.     <van-button square text="删除" type="danger" class="delete-button" />
  12.   </template>
  13. </van-swipe-cell>
  15. <style>
  16.   .goods-card {
  17.     margin: 0;
  18.     background-color: @white;
  19.   }
  21.   .delete-button {
  22.     height: 100%;
  23.   }
  24. </style>

异步关闭

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

  1. <van-swipe-cell :before-close="beforeClose">
  2.   <template #left>
  3.     <van-button square type="primary" text="选择" />
  4.   </template>
  5.   <van-cell :border="false" title="单元格" value="内容" />
  6.   <template #right>
  7.     <van-button square type="danger" text="删除" />
  8.   </template>
  9. </van-swipe-cell>
  1. import { Dialog } from 'vant';
  3. export default {
  4.   setup() {
  5.     // position 为关闭时点击的位置
  6.     const beforeClose = ({ position }) => {
  7.       switch (position) {
  8.         case 'left':
  9.         case 'cell':
  10.         case 'outside':
  11.           return true;
  12.         case 'right':
  13.           return new Promise((resolve) => {
  14.             Dialog.confirm({
  15.               title: '确定删除吗？',
  16.             }).then(resolve);
  17.           });
  18.       }
  19.     };
  21.     return { beforeClose };
  22.   },
  23. };

API

Props

参数说明类型默认值
name标识符，可以在事件参数中获取到number | string-
left-width指定左侧滑动区域宽度，单位为pxnumber | stringauto
right-width指定右侧滑动区域宽度，单位为pxnumber | stringauto
before-close关闭前的回调函数，返回 false 可阻止关闭，支持返回 Promise(args) => boolean | Promise-
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

方法

通过 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-

常见问题

在桌面端无法操作组件？

参见桌面端适配。

SwipeCell 滑动单元格 - 图1