Vant3 SwipeCell 滑动单元格

介绍

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

实例演示

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from vue;
import { SwipeCell } from vant;

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>
  <van-card
    num="2"
    price="2.00"
    desc="描述信息"
    title="商品标题"
    class="goods-card"
    thumb="https://img.yzcdn.cn/vant/cat.jpeg"
  />
  <template #right>
    <van-button square text="删除" type="danger" class="delete-button" />
  </template>
</van-swipe-cell>

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

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

异步关闭

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

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

import { Dialog } from vant;

export default {
  setup() {
    // position 为关闭时点击的位置
    const beforeClose = ({ position }) => {
      switch (position) {
        case left:
        case cell:
        case outside:
          return true;
        case right:
          return new Promise((resolve) => {
            Dialog.confirm({
              title: 确定删除吗？,
            }).then(resolve);
          });
      }
    };

    return { beforeClose };
  },
};

API

Props

参数	说明	类型	默认值
name	标识符，可以在事件参数中获取到	number \| string
left-width	指定左侧滑动区域宽度，单位为 `px`	number \| string	`auto`
right-width	指定右侧滑动区域宽度，单位为 `px`	number \| string	`auto`
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	收起单元格侧边栏	–	–

类型定义

通过 SwipeCellInstance 获取 SwipeCell 实例的类型定义。

import { ref } from vue;
import type { SwipeCellInstance } from vant;

const swipeCellRef = ref<SwipeCellInstance>();

swipeCellRef.value?.close();

样式变量

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

名称	默认值	描述
–van-switch-cell-padding-top	var(–van-cell-vertical-padding) – 1px	–
–van-switch-cell-padding-bottom	var(–van-cell-vertical-padding) – 1px	–
–van-switch-cell-large-padding-top	var(–van-cell-large-vertical-padding) – 1px	–
–van-switch-cell-large-padding-bottom	var(–van-cell-large-vertical-padding) – 1px	–