Skip to content

List 无限滚动列表

瀑布流滚动加载,用于展示长列表,当列表即将滚动到底部时,会触发事件并加载更多列表项。

基础用法

错误提示

下拉刷新

API

Props

参数说明类型默认值
v-model:loading是否处于加载状态,加载过程中不触发 load 事件booleanfalse
v-model:error是否加载失败,加载失败后点击错误提示可以重新触发 load 事件booleanfalse
finished是否已加载完成,加载完成后不再触发 load 事件booleanfalse
offset滚动条与底部距离小于 offset 时触发 load 事件number | string300
loading-text加载过程中的提示文案string加载中...
finished-text加载完成后的提示文案string-
error-text加载失败后的提示文案string-
immediate-check是否在初始化时立即执行滚动位置检查booleantrue
disabled是否禁用滚动加载booleanfalse
direction滚动触发加载的方向,可选值为 upstringdown
scroller v1.10.1指定需要监听滚动事件的节点,默认为最近的父级滚动节点Element-

Events

事件名说明回调参数
load滚动条与底部距离小于 offset 时触发-

方法

通过 ref 可以获取到 List 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
check检查当前的滚动位置,若已滚动至底部,则会触发 load 事件--

类型定义

组件导出以下类型定义:

ts
import type { ListProps, ListInstance, ListDirection } from 'ryxon'

ListInstance 是组件实例的类型,用法如下:

ts
import { ref } from 'vue'
import type { ListInstance } from 'ryxon'

const listRef = ref<ListInstance>()

listRef.value?.check()

Slots

名称说明
default列表内容
loading自定义底部加载中提示
finished自定义加载完成后的提示文案
error自定义加载失败后的提示文案

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-list-text-colorvar(--r-text-color-2)-
--r-list-text-font-sizevar(--r-font-size-md)-
--r-list-text-line-height50px-
--r-list-loading-icon-size16px-

常见问题

List 的运行机制是什么?

List 会监听浏览器的滚动事件并计算列表的位置,当列表底部与可视区域的距离小于 offset 时,List 会触发一次 load 事件。

为什么 List 初始化后会立即触发 load 事件?

List 初始化后会触发一次 load 事件,用于加载第一屏的数据,这个特性可以通过 immediate-check 属性关闭。

为什么会连续触发 load 事件?

如果一次请求加载的数据条数较少,导致列表内容无法铺满当前屏幕,List 会继续触发 load 事件,直到内容铺满屏幕或数据全部加载完成。

因此你需要调整每次获取的数据条数,理想情况下每次请求获取的数据条数应能够填满一屏高度。

loading 和 finished 分别是什么含义?

List 有以下三种状态,理解这些状态有助于你正确地使用 List 组件:

  • 非加载中,loadingfalse,此时会根据列表滚动位置判断是否触发 load 事件(列表内容不足一屏幕时,会直接触发)。
  • 加载中,loadingtrue,表示正在发送异步请求,此时不会触发 load 事件。
  • 加载完成,finishedtrue,此时不会触发 load 事件。

在每次请求完毕后,需要手动将 loading 设置为 false,表示加载结束。

使用 float 布局后一直触发加载?

若 List 的内容使用了 float 布局,可以在容器上添加 r-clearfix 类名来清除浮动,使得 List 能正确判断元素位置。

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

在 html、body 上设置 overflow 后一直触发加载?

如果在 html 和 body 标签上设置了 overflow-x: hidden 样式,会导致 List 一直触发加载。

css
html,
body {
  overflow-x: hidden;
}

这个问题的原因是当元素设置了 overflow-x: hidden 样式时,该元素的 overflow-y 会被浏览器设置为 auto,而不是默认值 visible,导致 List 无法正确地判断滚动容器。解决方法是去除该样式,或者在 html 和 body 标签上添加 height: 100% 样式。

direction 属性设置为 up 后一直触发加载?

设置 direction 属性为 up 后,当滚动条处于页面顶部时,就会触发 List 组件的加载。

因此在使用该属性时,建议在每次数据加载完成后,将滚动条滚动至页面底部或非顶部的位置。

Released under the MIT License.