Vant List 列表

介紹

瀑布流滾動加載，用于展示長列表，當列表即將滾動到底部時，會觸發(fā)事件并加載更多列表項。

引入

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

Vue.use(List);

代碼演示

基礎用法

List 組件通過loading和finished兩個變量控制加載狀態(tài)，當組件滾動到底部時，會觸發(fā)load事件并將loading設置成true。此時可以發(fā)起異步操作并更新數(shù)據(jù)，數(shù)據(jù)更新完畢后，將loading設置成false即可。若數(shù)據(jù)已全部加載完畢，則直接將finished設置成true即可。

<van-list
  v-model="loading"
  :finished="finished"
  finished-text="沒有更多了"
  @load="onLoad"
>
  <van-cell v-for="item in list" :key="item" :title="item" />
</van-list>

export default {
  data() {
    return {
      list: [],
      loading: false,
      finished: false
    };
  },
  methods: {
    onLoad() {
      // 異步更新數(shù)據(jù)
      // setTimeout 僅做示例，真實場景中一般為 ajax 請求
      setTimeout(() => {
        for (let i = 0; i < 10; i++) {
          this.list.push(this.list.length + 1);
        }

        // 加載狀態(tài)結束
        this.loading = false;

        // 數(shù)據(jù)全部加載完成
        if (this.list.length >= 40) {
          this.finished = true;
        }
      }, 1000);
    }
  }
}

錯誤提示

若列表數(shù)據(jù)加載失敗，將error設置成true即可顯示錯誤提示，用戶點擊錯誤提示后會重新觸發(fā) load 事件。

<van-list
  v-model="loading"
  :error.sync="error"
  error-text="請求失敗，點擊重新加載"
  @load="onLoad"
>
  <van-cell v-for="item in list" :key="item" :title="item" />
</van-list>

export default {
  data() {
    return {
      list: [],
      error: false,
      loading: false
    };
  },
  methods: {
    onLoad() {
      fetchSomeThing().catch(() => {
        this.error = true;
      })
    }
  }
}

下拉刷新

List 組件可以與 PullRefresh 組件結合使用，實現(xiàn)下拉刷新的效果

<van-pull-refresh v-model="refreshing" @refresh="onRefresh">
  <van-list
    v-model="loading"
    :finished="finished"
    finished-text="沒有更多了"
    @load="onLoad"
  >
    <van-cell v-for="item in list" :key="item" :title="item" />
  </van-list>
</van-pull-refresh>

export default {
  data() {
    return {
      list: [],
      loading: false,
      finished: false,
      refreshing: false
    };
  },
  methods: {
    onLoad() {
      setTimeout(() => {
        if (this.refreshing) {
          this.list = [];
          this.refreshing = false;
        }

        for (let i = 0; i < 10; i++) {
          this.list.push(this.list.length + 1);
        }
        this.loading = false;

        if (this.list.length >= 40) {
          this.finished = true;
        }
      }, 1000);
    },
    onRefresh() {
      // 清空列表數(shù)據(jù)
      this.finished = false;

      // 重新加載數(shù)據(jù)
      // 將 loading 設置為 true，表示處于加載狀態(tài)
      this.loading = true;
      this.onLoad();
    }
  }
}

API

Props

Events

方法

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

Slots

常見問題

List 的運行機制是什么？

List 會監(jiān)聽瀏覽器的滾動事件并計算列表的位置，當列表底部與可視區(qū)域的距離小于offset時，List 會觸發(fā)一次 load 事件。

為什么 List 初始化后會立即觸發(fā) load 事件？

List 初始化后會觸發(fā)一次 load 事件，用于加載第一屏的數(shù)據(jù)，這個特性可以通過immediate-check屬性關閉。

為什么會連續(xù)觸發(fā) load 事件？

如果一次請求加載的數(shù)據(jù)條數(shù)較少，導致列表內容無法鋪滿當前屏幕，List 會繼續(xù)觸發(fā) load 事件，直到內容鋪滿屏幕或數(shù)據(jù)全部加載完成。因此你需要調整每次獲取的數(shù)據(jù)條數(shù)，理想情況下每次請求獲取的數(shù)據(jù)條數(shù)應能夠填滿一屏高度。

loading 和 finished 分別是什么含義？

List有以下三種狀態(tài)，理解這些狀態(tài)有助于你正確地使用List組件：

• 非加載中，loading為false，此時會根據(jù)列表滾動位置判斷是否觸發(fā)load事件（列表內容不足一屏幕時，會直接觸發(fā)）
• 加載中，loading為true，表示正在發(fā)送異步請求，此時不會觸發(fā)load事件
• 加載完成，finished為true，此時不會觸發(fā)load事件

在每次請求完畢后，需要手動將loading設置為false，表示加載結束

使用 float 布局后一直觸發(fā)加載？

若 List 的內容使用了 float 布局，可以在容器上添加van-clearfix類名來清除浮動，使得 List 能正確判斷元素位置

<van-list>
  <div class="van-clearfix">
    <div class="float-item" />
    <div class="float-item" />
    <div class="float-item" />
  </div>
</van-list>

在 html、body 上設置 overflow 后一直觸發(fā)加載？

如果在 html 和 body 標簽上設置了overflow-x: hidden樣式，會導致 List 一直觸發(fā)加載。

html,
body {
  overflow-x: hidden;
}

這個問題的原因是當元素設置了overflow-x: hidden樣式時，該元素的overflow-y會被瀏覽器設置為auto，而不是默認值visible，導致 List 無法正確地判斷滾動容器。解決方法是去除該樣式，或者在 html 和 body 標簽上添加height: 100%樣式。