vant/src/swipe-cell/README.zh-CN.md

SwipeCell 滑动单元格

引入

import Vue from 'vue';
import { SwipeCell } from 'vant';

Vue.use(SwipeCell);

代码演示

基础用法

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

<van-swipe-cell>
  <template slot="left">
    <van-button square type="primary" text="选择" />
  </template>

  <van-cell :border="false" title="单元格" value="内容" />

  <template slot="right">
    <van-button square type="danger" text="删除" />
    <van-button square type="primary" text="收藏"/>
  </template>
</van-swipe-cell>

异步关闭

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

<van-swipe-cell :on-close="onClose">
  <template slot="left">
    <van-button square type="primary" text="选择" />
  </template>

  <van-cell :border="false" title="单元格" value="内容" />

  <template slot="right">
    <van-button square type="danger" text="删除" />
  </template>
</van-swipe-cell>

export default {
  methods: {
    // clickPosition 表示关闭时点击的位置
    onClose(clickPosition, instance) {
      switch (clickPosition) {
        case 'left':
        case 'cell':
        case 'outside':
          instance.close();
          break;
        case 'right':
          Dialog.confirm({
            message: '确定删除吗？'
          }).then(() => {
            instance.close();
          });
          break;
      }
    }
  }
}

API

Props

参数	说明	类型	默认值	版本
name	标识符，可以在 onClose 的参数中获取到	string | number	-	2.0.4
on-close	关闭时的回调函数	Function	-	-
disabled	是否禁用滑动	boolean	false	-
left-width	指定左侧滑动区域宽度	number	auto	-
right-width	指定右侧滑动区域宽度	number	auto	-
stop-propagation	是否阻止滑动事件冒泡	boolean	false	2.1.0

Slots

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

Events

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

onClose 参数

参数名	说明	类型
clickPosition	关闭时的点击位置 (left right cell outside)	string
instance	SwipeCell 实例，用于调用实例方法	object
detail	额外信息，包含 name 字段	object

方法

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

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

常见问题

在桌面端无法操作组件？

参见在桌面端使用。