引入
import Vue from 'vue';
import { List } from 'vant';
Vue.use(List);
基础用法
List 组件通过loading和finished两个变量控制加载状态,当组件滚动到底部时,会触发load事件并将loading设置成true。此时可以发起异步操作并更新数据,数据更新完毕后,将loading设置成false即可。若数据已全部加载完毕,则直接将finished设置成true即可。
export default {
data() {
return {
list: [],
loading: false,
finished: false,
};
},
methods: {
onLoad() {
// 异步更新数据
// setTimeout 仅做示例,真实场景中一般为 ajax 请求
setTimeout(() => {
for (let i = 0; i < 10 i this.list.pushthis.list.length 1 this.loading='false;' if this.list.length>= 40) {
this.finished = true;
}
}, 1000);
},
},
};
API
Props
参数说明类型默认值v-model是否处于加载状态,加载过程中不触发load事件booleanfalsefinished是否已加载完成,加载完成后不再触发load事件booleanfalseerror是否加载失败,加载失败后点击错误提示可以重新
触发load事件,必须使用sync修饰符booleanfalseoffset滚动条与底部距离小于 offset 时触发load事件number | string300loading-text加载过程中的提示文案string加载中...finished-text加载完成后的提示文案string-error-text加载失败后的提示文案string-immediate-check是否在初始化时立即执行滚动位置检查booleantruedirection滚动触发加载的方向,可选值为upstringdown
Events
事件名说明回调参数load滚动条与底部距离小于 offset 时触发-
方法
通过 ref 可以获取到 List 实例并调用实例方法,详见组件实例方法
方法名说明参数返回值check检查当前的滚动位置,若已滚动至底部,则会触发 load 事件--
Slots
名称说明default列表内容loading自定义底部加载中提示finished自定义加载完成后的提示文案error自定义加载失败后的提示文案
常见问题
List 的运行机制是什么?
List 会监听浏览器的滚动事件并计算列表的位置,当列表底部与可视区域的距离小于offset时,List 会触发一次 load 事件。
为什么 List 初始化后会立即触发 load 事件?
List 初始化后会触发一次 load 事件,用于加载第一屏的数据,这个特性可以通过immediate-check属性关闭。
为什么会连续触发 load 事件?
如果一次请求加载的数据条数较少,导致列表内容无法铺满当前屏幕,List 会继续触发 load 事件,直到内容铺满屏幕或数据全部加载完成。因此你需要调整每次获取的数据条数,理想情况下每次请求获取的数据条数应能够填满一屏高度。
loading 和 finished 分别是什么含义?
List有以下三种状态,理解这些状态有助于你正确地使用List组件:
- 非加载中,loading为false,此时会根据列表滚动位置判断是否触发load事件(列表内容不足一屏幕时,会直接触发)
- 加载中,loading为true,表示正在发送异步请求,此时不会触发load事件
- 加载完成,finished为true,此时不会触发load事件
在每次请求完毕后,需要手动将loading设置为false,表示加载结束
使用 float 布局后一直触发加载?
若 List 的内容使用了 float 布局,可以在容器上添加van-clearfix类名来清除浮动,使得 List 能正确判断元素位置
在 html、body 上设置 overflow 后一直触发加载?
如果在 html 和 body 标签上设置了overflow-x: hidden样式,会导致 List 一直触发加载。
html,
body {
overflow-x: hidden;
}
这个问题的原因是当元素设置了overflow-x: hidden样式时,该元素的overflow-y会被浏览器设置为auto,而不是默认值visible,导致 List 无法正确地判断滚动容器。解决方法是去除该样式,或者在 html 和 body 标签上添加height: 100%样式。