Skip to content

List 虚拟列表

介绍

建议优先使用 uni-app 提供的 scroll-view 组件实现列表。

List 组件为虚拟列表组件,它可以只渲染当前可视区域,其他部分在用户滚动到可视区域内之后再渲染。

在绝大多数场景下,你并不需要使用到虚拟列表。它可能会出现滑动白屏、计算位置不精确等问题。

基础用法

html
<template>
  <div class="demo">
    <h2>基础用法</h2>
    <nut-cell>
      <nut-list :height="50" :listData="count" @scroll="handleScroll">
        <template v-slot="{ item, index }">
          <div class="list-item">
            {{ index }}
          </div>
        </template>
      </nut-list>
    </nut-cell>
  </div>
</template>
<script lang="ts">
import { onMounted, reactive, toRefs } from 'vue';
export default {
  props: {},
  setup() {
    const state = reactive({
      count: new Array(100).fill(0)
    });

    const handleScroll = () => {
      let arr = new Array(100).fill(0);
      const len = state.count.length;
      state.count = state.count.concat(arr.map((item: number, index: number) => len + index + 1));
    };

    onMounted(() => {
      state.count = state.count.map((item: number, index: number) => index + 1);
    })

    return { ...toRefs(state), handleScroll };
  }
};
</script>
<style lang="scss">
body {
  width: 100%;
  height: 100vh;
}
#app {
  width: 100%;
  height: 100%;
}
.demo {
  .nut-cell {
    height: 100%;
  }
  .nut-list-item {
    display: flex;
    align-items: center;
    justify-content: center;
    width: 100%;
    height: 50px;
    margin-bottom: 10px;
    background-color: #f4a8b6;
    border-radius: 10px;
  }
}
</style>

API

Props

参数说明类型默认值
height列表项的高度/预估高度,支持不固定高度Number80
list-data列表数据any[][]
container-height容器高度(最大值不能超过可视区)Number可视区高度

Slots

参数说明类型
item列表项数据Object
index列表索引Number

Events

事件名说明回调参数
scroll滚动到底部时触发-

MIT Licensed