Vant3 SwipeCell 滑動(dòng)單元格

介紹

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

實(shí)例演示

引入

通過以下方式來全局注冊(cè)組件，更多注冊(cè)方式請(qǐng)參考組件注冊(cè)。

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

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

代碼演示

基礎(chǔ)用法

SwipeCell 組件提供了 left 和 right 兩個(gè)插槽，用于定義兩側(cè)滑動(dòng)區(qū)域的內(nèi)容。

<van-swipe-cell>
  <template #left>
    <van-button square type="primary" text="選擇" />
  </template>
  <van-cell :border="false" title="單元格" value="內(nèi)容" />
  <template #right>
    <van-button square type="danger" text="刪除" />
    <van-button square type="primary" text="收藏" />
  </template>
</van-swipe-cell>

自定義內(nèi)容

SwipeCell 可以嵌套任意內(nèi)容，比如嵌套一個(gè)商品卡片。

<van-swipe-cell>
  <van-card
    num="2"
    price="2.00"
    desc="描述信息"
    title="商品標(biāo)題"
    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>

異步關(guān)閉

通過傳入 before-close 回調(diào)函數(shù)，可以自定義兩側(cè)滑動(dòng)內(nèi)容關(guān)閉時(shí)的行為。

<van-swipe-cell :before-close="beforeClose">
  <template #left>
    <van-button square type="primary" text="選擇" />
  </template>
  <van-cell :border="false" title="單元格" value="內(nèi)容" />
  <template #right>
    <van-button square type="danger" text="刪除" />
  </template>
</van-swipe-cell>

import { Dialog } from 'vant';

export default {
  setup() {
    // position 為關(guān)閉時(shí)點(diǎn)擊的位置
    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

Slots

Events

beforeClose 參數(shù)

beforeClose 的第一個(gè)參數(shù)為對(duì)象，對(duì)象中包含以下屬性：

方法

通過 ref 可以獲取到 SwipeCell 實(shí)例并調(diào)用實(shí)例方法，詳見組件實(shí)例方法。

類型定義

通過 SwipeCellInstance 獲取 SwipeCell 實(shí)例的類型定義。

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

const swipeCellRef = ref<SwipeCellInstance>();

swipeCellRef.value?.close();

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請(qǐng)參考 ConfigProvider 組件。

常見問題

在桌面端無法操作組件？

參見桌面端適配。