import{o as a,a as n,y as t}from"./vue-libs.b44bc779.js";const l={class:"van-doc-markdown-body"},e=t(`

List \u5217\u8868

\u4ECB\u7ECD

\u7011\u5E03\u6D41\u6EDA\u52A8\u52A0\u8F7D\uFF0C\u7528\u4E8E\u5C55\u793A\u957F\u5217\u8868\uFF0C\u5F53\u5217\u8868\u5373\u5C06\u6EDA\u52A8\u5230\u5E95\u90E8\u65F6\uFF0C\u4F1A\u89E6\u53D1\u4E8B\u4EF6\u5E76\u52A0\u8F7D\u66F4\u591A\u5217\u8868\u9879\u3002

\u5F15\u5165

\u901A\u8FC7\u4EE5\u4E0B\u65B9\u5F0F\u6765\u5168\u5C40\u6CE8\u518C\u7EC4\u4EF6\uFF0C\u66F4\u591A\u6CE8\u518C\u65B9\u5F0F\u8BF7\u53C2\u8003\u7EC4\u4EF6\u6CE8\u518C\u3002

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

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

\u4EE3\u7801\u6F14\u793A

\u57FA\u7840\u7528\u6CD5

List \u7EC4\u4EF6\u901A\u8FC7 loading \u548C finished \u4E24\u4E2A\u53D8\u91CF\u63A7\u5236\u52A0\u8F7D\u72B6\u6001\uFF0C\u5F53\u7EC4\u4EF6\u6EDA\u52A8\u5230\u5E95\u90E8\u65F6\uFF0C\u4F1A\u89E6\u53D1 load \u4E8B\u4EF6\u5E76\u5C06 loading \u8BBE\u7F6E\u6210 true\u3002\u6B64\u65F6\u53EF\u4EE5\u53D1\u8D77\u5F02\u6B65\u64CD\u4F5C\u5E76\u66F4\u65B0\u6570\u636E\uFF0C\u6570\u636E\u66F4\u65B0\u5B8C\u6BD5\u540E\uFF0C\u5C06 loading \u8BBE\u7F6E\u6210 false \u5373\u53EF\u3002\u82E5\u6570\u636E\u5DF2\u5168\u90E8\u52A0\u8F7D\u5B8C\u6BD5\uFF0C\u5219\u76F4\u63A5\u5C06 finished \u8BBE\u7F6E\u6210 true \u5373\u53EF\u3002

<van-list
  v-model:loading="loading"
  :finished="finished"
  finished-text="\u6CA1\u6709\u66F4\u591A\u4E86"
  @load="onLoad"
>
  <van-cell v-for="item in list" :key="item" :title="item" />
</van-list>

import { ref } from 'vue';

export default {
  setup() {
    const list = ref([]);
    const loading = ref(false);
    const finished = ref(false);

    const onLoad = () => {
      // \u5F02\u6B65\u66F4\u65B0\u6570\u636E
      // setTimeout \u4EC5\u505A\u793A\u4F8B\uFF0C\u771F\u5B9E\u573A\u666F\u4E2D\u4E00\u822C\u4E3A ajax \u8BF7\u6C42
      setTimeout(() => {
        for (let i = 0; i < 10; i++) {
          list.value.push(list.value.length + 1);
        }

        // \u52A0\u8F7D\u72B6\u6001\u7ED3\u675F
        loading.value = false;

        // \u6570\u636E\u5168\u90E8\u52A0\u8F7D\u5B8C\u6210
        if (list.value.length >= 40) {
          finished.value = true;
        }
      }, 1000);
    };

    return {
      list,
      onLoad,
      loading,
      finished,
    };
  },
};

\u9519\u8BEF\u63D0\u793A

\u82E5\u5217\u8868\u6570\u636E\u52A0\u8F7D\u5931\u8D25\uFF0C\u5C06 error \u8BBE\u7F6E\u6210 true \u5373\u53EF\u663E\u793A\u9519\u8BEF\u63D0\u793A\uFF0C\u7528\u6237\u70B9\u51FB\u9519\u8BEF\u63D0\u793A\u540E\u4F1A\u91CD\u65B0\u89E6\u53D1 load \u4E8B\u4EF6\u3002

<van-list
  v-model:loading="loading"
  v-model:error="error"
  error-text="\u8BF7\u6C42\u5931\u8D25\uFF0C\u70B9\u51FB\u91CD\u65B0\u52A0\u8F7D"
  @load="onLoad"
>
  <van-cell v-for="item in list" :key="item" :title="item" />
</van-list>

import { ref } from 'vue';

export default {
  setup() {
    const list = ref([]);
    const error = ref(false);
    const loading = ref(false);
    const onLoad = () => {
      fetchSomeThing().catch(() => {
        error.value = true;
      });
    };

    return {
      list,
      error,
      onLoad,
      loading,
    };
  },
};

\u4E0B\u62C9\u5237\u65B0

List \u7EC4\u4EF6\u53EF\u4EE5\u4E0E PullRefresh \u7EC4\u4EF6\u7ED3\u5408\u4F7F\u7528\uFF0C\u5B9E\u73B0\u4E0B\u62C9\u5237\u65B0\u7684\u6548\u679C\u3002

<van-pull-refresh v-model="refreshing" @refresh="onRefresh">
  <van-list
    v-model:loading="loading"
    :finished="finished"
    finished-text="\u6CA1\u6709\u66F4\u591A\u4E86"
    @load="onLoad"
  >
    <van-cell v-for="item in list" :key="item" :title="item" />
  </van-list>
</van-pull-refresh>

import { ref } from 'vue';

export default {
  setup() {
    const list = ref([]);
    const loading = ref(false);
    const finished = ref(false);
    const refreshing = ref(false);

    const onLoad = () => {
      setTimeout(() => {
        if (refreshing.value) {
          list.value = [];
          refreshing.value = false;
        }

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

        if (list.value.length >= 40) {
          finished.value = true;
        }
      }, 1000);
    };

    const onRefresh = () => {
      // \u6E05\u7A7A\u5217\u8868\u6570\u636E
      finished.value = false;

      // \u91CD\u65B0\u52A0\u8F7D\u6570\u636E
      // \u5C06 loading \u8BBE\u7F6E\u4E3A true\uFF0C\u8868\u793A\u5904\u4E8E\u52A0\u8F7D\u72B6\u6001
      loading.value = true;
      onLoad();
    };

    return {
      list,
      onLoad,
      loading,
      finished,
      onRefresh,
      refreshing,
    };
  },
};

API

Props

\u53C2\u6570\u8BF4\u660E\u7C7B\u578B\u9ED8\u8BA4\u503C
v-model:loading\u662F\u5426\u5904\u4E8E\u52A0\u8F7D\u72B6\u6001\uFF0C\u52A0\u8F7D\u8FC7\u7A0B\u4E2D\u4E0D\u89E6\u53D1 load \u4E8B\u4EF6booleanfalse
v-model:error\u662F\u5426\u52A0\u8F7D\u5931\u8D25\uFF0C\u52A0\u8F7D\u5931\u8D25\u540E\u70B9\u51FB\u9519\u8BEF\u63D0\u793A\u53EF\u4EE5\u91CD\u65B0\u89E6\u53D1 load \u4E8B\u4EF6booleanfalse
finished\u662F\u5426\u5DF2\u52A0\u8F7D\u5B8C\u6210\uFF0C\u52A0\u8F7D\u5B8C\u6210\u540E\u4E0D\u518D\u89E6\u53D1 load \u4E8B\u4EF6booleanfalse
offset\u6EDA\u52A8\u6761\u4E0E\u5E95\u90E8\u8DDD\u79BB\u5C0F\u4E8E offset \u65F6\u89E6\u53D1 load \u4E8B\u4EF6number | string300
loading-text\u52A0\u8F7D\u8FC7\u7A0B\u4E2D\u7684\u63D0\u793A\u6587\u6848string\u52A0\u8F7D\u4E2D...
finished-text\u52A0\u8F7D\u5B8C\u6210\u540E\u7684\u63D0\u793A\u6587\u6848string-
error-text\u52A0\u8F7D\u5931\u8D25\u540E\u7684\u63D0\u793A\u6587\u6848string-
immediate-check\u662F\u5426\u5728\u521D\u59CB\u5316\u65F6\u7ACB\u5373\u6267\u884C\u6EDA\u52A8\u4F4D\u7F6E\u68C0\u67E5booleantrue
direction\u6EDA\u52A8\u89E6\u53D1\u52A0\u8F7D\u7684\u65B9\u5411\uFF0C\u53EF\u9009\u503C\u4E3A upstringdown

Events

\u4E8B\u4EF6\u540D\u8BF4\u660E\u56DE\u8C03\u53C2\u6570
load\u6EDA\u52A8\u6761\u4E0E\u5E95\u90E8\u8DDD\u79BB\u5C0F\u4E8E offset \u65F6\u89E6\u53D1-

\u65B9\u6CD5

\u901A\u8FC7 ref \u53EF\u4EE5\u83B7\u53D6\u5230 List \u5B9E\u4F8B\u5E76\u8C03\u7528\u5B9E\u4F8B\u65B9\u6CD5\uFF0C\u8BE6\u89C1\u7EC4\u4EF6\u5B9E\u4F8B\u65B9\u6CD5\u3002

\u65B9\u6CD5\u540D\u8BF4\u660E\u53C2\u6570\u8FD4\u56DE\u503C
check\u68C0\u67E5\u5F53\u524D\u7684\u6EDA\u52A8\u4F4D\u7F6E\uFF0C\u82E5\u5DF2\u6EDA\u52A8\u81F3\u5E95\u90E8\uFF0C\u5219\u4F1A\u89E6\u53D1 load \u4E8B\u4EF6--

\u7C7B\u578B\u5B9A\u4E49

\u7EC4\u4EF6\u5BFC\u51FA\u4EE5\u4E0B\u7C7B\u578B\u5B9A\u4E49\uFF1A

import type { ListProps, ListInstance, ListDirection } from 'vant';

ListInstance \u662F\u7EC4\u4EF6\u5B9E\u4F8B\u7684\u7C7B\u578B\uFF0C\u7528\u6CD5\u5982\u4E0B\uFF1A

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

const listRef = ref<ListInstance>();

listRef.value?.check();

Slots

\u540D\u79F0\u8BF4\u660E
default\u5217\u8868\u5185\u5BB9
loading\u81EA\u5B9A\u4E49\u5E95\u90E8\u52A0\u8F7D\u4E2D\u63D0\u793A
finished\u81EA\u5B9A\u4E49\u52A0\u8F7D\u5B8C\u6210\u540E\u7684\u63D0\u793A\u6587\u6848
error\u81EA\u5B9A\u4E49\u52A0\u8F7D\u5931\u8D25\u540E\u7684\u63D0\u793A\u6587\u6848

\u4E3B\u9898\u5B9A\u5236

\u6837\u5F0F\u53D8\u91CF

\u7EC4\u4EF6\u63D0\u4F9B\u4E86\u4E0B\u5217 CSS \u53D8\u91CF\uFF0C\u53EF\u7528\u4E8E\u81EA\u5B9A\u4E49\u6837\u5F0F\uFF0C\u4F7F\u7528\u65B9\u6CD5\u8BF7\u53C2\u8003 ConfigProvider \u7EC4\u4EF6\u3002

\u540D\u79F0\u9ED8\u8BA4\u503C\u63CF\u8FF0
--van-list-text-colorvar(--van-text-color-2)-
--van-list-text-font-sizevar(--van-font-size-md)-
--van-list-text-line-height50px-
--van-list-loading-icon-size16px-

\u5E38\u89C1\u95EE\u9898

List \u7684\u8FD0\u884C\u673A\u5236\u662F\u4EC0\u4E48\uFF1F

List \u4F1A\u76D1\u542C\u6D4F\u89C8\u5668\u7684\u6EDA\u52A8\u4E8B\u4EF6\u5E76\u8BA1\u7B97\u5217\u8868\u7684\u4F4D\u7F6E\uFF0C\u5F53\u5217\u8868\u5E95\u90E8\u4E0E\u53EF\u89C6\u533A\u57DF\u7684\u8DDD\u79BB\u5C0F\u4E8E offset \u65F6\uFF0CList \u4F1A\u89E6\u53D1\u4E00\u6B21 load \u4E8B\u4EF6\u3002

\u4E3A\u4EC0\u4E48 List \u521D\u59CB\u5316\u540E\u4F1A\u7ACB\u5373\u89E6\u53D1 load \u4E8B\u4EF6\uFF1F

List \u521D\u59CB\u5316\u540E\u4F1A\u89E6\u53D1\u4E00\u6B21 load \u4E8B\u4EF6\uFF0C\u7528\u4E8E\u52A0\u8F7D\u7B2C\u4E00\u5C4F\u7684\u6570\u636E\uFF0C\u8FD9\u4E2A\u7279\u6027\u53EF\u4EE5\u901A\u8FC7 immediate-check \u5C5E\u6027\u5173\u95ED\u3002

\u4E3A\u4EC0\u4E48\u4F1A\u8FDE\u7EED\u89E6\u53D1 load \u4E8B\u4EF6\uFF1F

\u5982\u679C\u4E00\u6B21\u8BF7\u6C42\u52A0\u8F7D\u7684\u6570\u636E\u6761\u6570\u8F83\u5C11\uFF0C\u5BFC\u81F4\u5217\u8868\u5185\u5BB9\u65E0\u6CD5\u94FA\u6EE1\u5F53\u524D\u5C4F\u5E55\uFF0CList \u4F1A\u7EE7\u7EED\u89E6\u53D1 load \u4E8B\u4EF6\uFF0C\u76F4\u5230\u5185\u5BB9\u94FA\u6EE1\u5C4F\u5E55\u6216\u6570\u636E\u5168\u90E8\u52A0\u8F7D\u5B8C\u6210\u3002

\u56E0\u6B64\u4F60\u9700\u8981\u8C03\u6574\u6BCF\u6B21\u83B7\u53D6\u7684\u6570\u636E\u6761\u6570\uFF0C\u7406\u60F3\u60C5\u51B5\u4E0B\u6BCF\u6B21\u8BF7\u6C42\u83B7\u53D6\u7684\u6570\u636E\u6761\u6570\u5E94\u80FD\u591F\u586B\u6EE1\u4E00\u5C4F\u9AD8\u5EA6\u3002

loading \u548C finished \u5206\u522B\u662F\u4EC0\u4E48\u542B\u4E49\uFF1F

List \u6709\u4EE5\u4E0B\u4E09\u79CD\u72B6\u6001\uFF0C\u7406\u89E3\u8FD9\u4E9B\u72B6\u6001\u6709\u52A9\u4E8E\u4F60\u6B63\u786E\u5730\u4F7F\u7528 List \u7EC4\u4EF6\uFF1A

\u5728\u6BCF\u6B21\u8BF7\u6C42\u5B8C\u6BD5\u540E\uFF0C\u9700\u8981\u624B\u52A8\u5C06 loading \u8BBE\u7F6E\u4E3A false\uFF0C\u8868\u793A\u52A0\u8F7D\u7ED3\u675F\u3002

\u4F7F\u7528 float \u5E03\u5C40\u540E\u4E00\u76F4\u89E6\u53D1\u52A0\u8F7D\uFF1F

\u82E5 List \u7684\u5185\u5BB9\u4F7F\u7528\u4E86 float \u5E03\u5C40\uFF0C\u53EF\u4EE5\u5728\u5BB9\u5668\u4E0A\u6DFB\u52A0 van-clearfix \u7C7B\u540D\u6765\u6E05\u9664\u6D6E\u52A8\uFF0C\u4F7F\u5F97 List \u80FD\u6B63\u786E\u5224\u65AD\u5143\u7D20\u4F4D\u7F6E\u3002

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

\u5728 html\u3001body \u4E0A\u8BBE\u7F6E overflow \u540E\u4E00\u76F4\u89E6\u53D1\u52A0\u8F7D\uFF1F

\u5982\u679C\u5728 html \u548C body \u6807\u7B7E\u4E0A\u8BBE\u7F6E\u4E86 overflow-x: hidden \u6837\u5F0F\uFF0C\u4F1A\u5BFC\u81F4 List \u4E00\u76F4\u89E6\u53D1\u52A0\u8F7D\u3002

html,
body {
  overflow-x: hidden;
}

\u8FD9\u4E2A\u95EE\u9898\u7684\u539F\u56E0\u662F\u5F53\u5143\u7D20\u8BBE\u7F6E\u4E86 overflow-x: hidden \u6837\u5F0F\u65F6\uFF0C\u8BE5\u5143\u7D20\u7684 overflow-y \u4F1A\u88AB\u6D4F\u89C8\u5668\u8BBE\u7F6E\u4E3A auto\uFF0C\u800C\u4E0D\u662F\u9ED8\u8BA4\u503C visible\uFF0C\u5BFC\u81F4 List \u65E0\u6CD5\u6B63\u786E\u5730\u5224\u65AD\u6EDA\u52A8\u5BB9\u5668\u3002\u89E3\u51B3\u65B9\u6CD5\u662F\u53BB\u9664\u8BE5\u6837\u5F0F\uFF0C\u6216\u8005\u5728 html \u548C body \u6807\u7B7E\u4E0A\u6DFB\u52A0 height: 100% \u6837\u5F0F\u3002

direction \u5C5E\u6027\u8BBE\u7F6E\u4E3A up \u540E\u4E00\u76F4\u89E6\u53D1\u52A0\u8F7D\uFF1F

\u8BBE\u7F6E direction \u5C5E\u6027\u4E3A up \u540E\uFF0C\u5F53\u6EDA\u52A8\u6761\u5904\u4E8E\u9875\u9762\u9876\u90E8\u65F6\uFF0C\u5C31\u4F1A\u89E6\u53D1 List \u7EC4\u4EF6\u7684\u52A0\u8F7D\u3002

\u56E0\u6B64\u5728\u4F7F\u7528\u8BE5\u5C5E\u6027\u65F6\uFF0C\u5EFA\u8BAE\u5728\u6BCF\u6B21\u6570\u636E\u52A0\u8F7D\u5B8C\u6210\u540E\uFF0C\u5C06\u6EDA\u52A8\u6761\u6EDA\u52A8\u81F3\u9875\u9762\u5E95\u90E8\u6216\u975E\u9876\u90E8\u7684\u4F4D\u7F6E\u3002

`,23),p=[e],r={__name:"README.zh-CN",setup(d,{expose:s}){return s({frontmatter:{}}),(o,i)=>(a(),n("div",l,p))}};export{r as default};