介紹

可以左右滑動來展示操作按鈕的單元格組件。

引入

通過以下方式來全局注冊組件，更多注冊方式請參考組件注冊。

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

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

代碼演示

基礎用法

?SwipeCell? 組件提供了 ?left? 和 ?right? 兩個插槽，用于定義兩側滑動區(qū)域的內容。

<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://fastly.jsdelivr.net/npm/@vant/assets/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 { showConfirmDialog } 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) => {
            showConfirmDialog({
              title: '確定刪除嗎？',
            }).then(resolve);
          });
      }
    };

    return { beforeClose };
  },
};

API

Props

Slots

Events

beforeClose 參數

beforeClose 的第一個參數為對象，對象中包含以下屬性：

方法

通過 ref 可以獲取到 SwipeCell 實例并調用實例方法，詳見組件實例方法。

類型定義

組件導出以下類型定義：

import type {
  SwipeCellSide,
  SwipeCellProps,
  SwipeCellPosition,
  SwipeCellInstance,
} from 'vant';

SwipeCellInstance 是組件實例的類型，用法如下：

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

const swipeCellRef = ref<SwipeCellInstance>();

swipeCellRef.value?.close();

常見問題

在桌面端無法操作組件？

參見桌面端適配。