Vant4 PullRefresh 下拉刷新

介紹

用于提供下拉刷新的交互操作。

引入

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

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

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

代碼演示

基礎(chǔ)用法

下拉刷新時會觸發(fā) ?refresh? 事件，在事件的回調(diào)函數(shù)中可以進(jìn)行同步或異步操作，操作完成后將 ?v-model? 設(shè)置為 ?false?，表示加載完成。

<van-pull-refresh v-model="loading" @refresh="onRefresh">
  <p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>

import { ref } from 'vue';
import { showToast } from 'vant';

export default {
  setup() {
    const count = ref(0);
    const loading = ref(false);
    const onRefresh = () => {
      setTimeout(() => {
        showToast('刷新成功');
        loading.value = false;
        count.value++;
      }, 1000);
    };

    return {
      count,
      loading,
      onRefresh,
    };
  },
};

成功提示

通過 ?success-text? 可以設(shè)置刷新成功后的頂部提示文案。

<van-pull-refresh
  v-model="isLoading"
  success-text="刷新成功"
  @refresh="onRefresh"
>
  <p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>

自定義提示

通過插槽可以自定義下拉刷新過程中的提示內(nèi)容。

<van-pull-refresh v-model="isLoading" :head-height="80" @refresh="onRefresh">
  <!-- 下拉提示，通過 scale 實現(xiàn)一個縮放效果 -->
  <template #pulling="props">
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge.png" rel="external nofollow"  rel="external nofollow" 
      :style="{ transform: `scale(${props.distance / 80})` }"
    />
  </template>

  <!-- 釋放提示 -->
  <template #loosing>
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge.png" rel="external nofollow"  rel="external nofollow" 
    />
  </template>

  <!-- 加載提示 -->
  <template #loading>
    <img
      class="doge"
      src="https://fastly.jsdelivr.net/npm/@vant/assets/doge-fire.jpeg" rel="external nofollow" 
    />
  </template>
  <p>刷新次數(shù): {{ count }}</p>
</van-pull-refresh>

<style>
  .doge {
    width: 140px;
    height: 72px;
    margin-top: 8px;
    border-radius: 4px;
  }
</style>

API

Props

Events

Slots

類型定義

組件導(dǎo)出以下類型定義：

import type { PullRefreshProps } from 'vant';

主題定制

樣式變量

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

常見問題

PullRefresh 的內(nèi)容未填滿屏幕時，只有一部分區(qū)域可以下拉？

默認(rèn)情況下，下拉區(qū)域的高度是和內(nèi)容高度保持一致的，如果需要讓下拉區(qū)域始終為全屏，可以給 PullRefresh 設(shè)置一個與屏幕大小相等的最小高度：

<van-pull-refresh style="min-height: 100vh;" />

PullRefresh 的觸發(fā)條件是？

PullRefresh 的觸發(fā)條件是「父級滾動元素的滾動條在頂部位置」。

• 如果最近一個可滾動的父級元素是 ?window?，則要求 ?window.pageYOffset === 0?。
• 如果最近一個可滾動的父級元素是 ?Element?，則要求 ?Element.scrollTop === 0?。

在桌面端無法操作組件？

參見桌面端適配。