React虚拟列表的实现代码

 更新时间:2023年08月27日 09:22:24   作者:Kakarotto  
最近看了vueuse的useVirtualList的实现方式,发现虚拟滚动效果不错,就尝试着同样的写法改成react版本,虚拟列表主要包含三部分组成,offset,viewcapacity,overscan,本文就给大家介绍一下React虚拟列表的实现,需要的朋友可以参考下

最近看了vueuse的useVirtualList的实现方式,发现虚拟滚动效果不错,就尝试着同样的写法改成react版本。

虚拟列表主要包含三部分组成,示意图如下:

定义一个 useVirtualList 的 hook 需要接收两个参数,一是接收所有的数据,二是定义一些配置参数;需要返回的四个参数,一是当前加载的列表,二是获取容器的 ref 和容器滚动事件,三是快速定位的方法,四是内层容器的样式。基本的代码结构如下:

export type UseVirtualListOptions = {
	// 如果是每条数据的高度相同为number 否则通过方法计算高度
	itemHeight: number | ((index: number) => number);
	overscan?: number;
};
export const useVirtualList = (
	list: AllItems[],
	options: UseVirtualListOptions
): UseVirtualListReturn => {
	const containerRef = useRef(null);
	const [currentList, setCurrentList] = useState<CurrentList[]>([]);
	const [wrapperStyle, setWrapperStyle] = useState({
		width: "100%",
		height: "0px",
		marginTop: "0px",
	});
	return {
		list: currentList,
		containerProps: {
			ref: containerRef,
			onScroll: () => {},
		},
		scrollTop,
		wrapperStyle,
	};
};

因为需要容器的高度和滚动距离来计算加载的内容,因此需要在 dom 挂载完成后执行。

1、计算容器的的高度能显示的数据

如果 itemHeight 类型为 number,则可以通过容器高度 / itemHeight 来计算容器能显示多少条数据,否则需要把上一次开始索引作为起始值,预估滚动之后能够在可视区域显示多少数据。

const getViewCapacity = (containerHeight: number) => {
	if (typeof itemHeight === "number") {
		return Math.ceil(containerHeight / itemHeight);
	}
	let sum = 0;
	let capacity = 0;
	const { start = 0 } = state;
	console.log(start);
	for (let i = start; i < list.length; i++) {
		const height = itemHeight(i);
		sum += height;
		if (sum >= containerHeight) {
			capacity = i;
			break;
		}
	}
	return capacity - start;
};

2、计算滚动偏移的数据量

如果 itemHeight 类型为 number,则可以通过容器高度 / itemHeight 来计算滚动偏移的数据量,否则需要对滚动偏移的 dom 高度进行累加,计算出偏移的数据量。

const getOffset = (scrollTop: number) => {
	if (typeof itemHeight === "number") {
		return Math.floor(scrollTop / itemHeight) + 1;
	}
	let sum = 0;
	let offset = 0;
	for (let i = 0; i < list.length; i++) {
		const height = itemHeight(i);
		sum += height;
		if (sum >= scrollTop) {
			offset = i;
			break;
		}
	}
	return offset + 1;
};

3、计算滚动时需要加载的数据

需要加载的数据开始位置 = 滚动偏移量 - 预加载的数量
需要加载的数据结束位置 = 滚动偏移量 + 可视区域显示数据量 + 预加载数据量
如果开始位置 < 0 则从 0 开始,结束位置大于总数组长度,则结束位置为总数据的长度

const from = offset - overscan;
const to = offset + viewCapacity + overscan;
state.start = from < 0 ? 0 : from;
state.end = to > list.length ? list.length : to;
setCurrentList(() => {
	return list.slice(state.start, state.end).map((ele, index) => ({
		data: ele,
		index: index + state.start,
	}));
});

4、计算列表容器的高度和滚动的高度

列表容器的高度 = 数据长度 * 预估每条数据的高度 - 滚动偏移的高度

因为加载的数据不是每次都从 0 开始,但每次渲染是从顶部开始的,所以滚动到高度大于数据的高度时,数据位于可视区域的上方,此时需要设置 marginTop,让加载的数据显示在可视区域的顶部,但如果总高度不变,数据全部加载完成后,底部会有大面积留白。

const computedWrapperStype = () => {
	const offsetTop = getDistanceTop(state.start);
	setWrapperStyle({
		width: "100%",
		height: `${totalHeight() - offsetTop}px`,
		marginTop: `${offsetTop}px`,
	});
};

5、添加快速定位功能

当在输入框数据要定位的索引值时,可以根据索引值计算出可视区域上方需要偏移的高度,然后重新调用计算需要加载数据开始、结束位置的方法,即可实现快速定位。

const scrollTop = (index: number) => {
	if (containerRef.current) {
		(containerRef.current as HTMLDivElement).scrollTop = getDistanceTop(index);
		calculateRange();
	}
};

6、源码地址

https://stackblitz.com/edit/vitejs-vite-oy7obm?file=src%2FApp.tsx

到此这篇关于React虚拟列表的实现代码的文章就介绍到这了,更多相关React虚拟列表内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 比ant更丰富Modal组件功能实现示例详解

    比ant更丰富Modal组件功能实现示例详解

    这篇文章主要为大家介绍了比ant更丰富Modal组件功能实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • React router cache route实现缓存页面流程介绍

    React router cache route实现缓存页面流程介绍

    react-router自身没有路由缓存的特性,在5.x版本之前,我们可以基于react-router-cache-route来实现路由缓存功能。但是react-router 6.x在实现上做了比较大的变化,react-router-cache-route没有提供相应的支持
    2023-01-01
  • React之防止按钮多次点击事件 重复提交

    React之防止按钮多次点击事件 重复提交

    这篇文章主要介绍了React之防止按钮多次点击事件 重复提交问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-10-10
  • React SSG实现Demo详解

    React SSG实现Demo详解

    这篇文章主要为大家介绍了React SSG实现Demo详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪<BR>
    2023-07-07
  • 基于React.js实现原生js拖拽效果引发的思考

    基于React.js实现原生js拖拽效果引发的思考

    这篇文章主要为大家详细介绍了基于React.js实现原生js拖拽效果,继而引发的一系列思考,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-03-03
  • React Hook中的useState函数的详细解析

    React Hook中的useState函数的详细解析

    Hook 就是 JavaScript 函数,这个函数可以帮助你钩入(hook into) React State以及生命周期等特性,这篇文章主要介绍了React Hook useState函数的详细解析的相关资料,需要的朋友可以参考下
    2022-10-10
  • React实现复杂搜索表单的展开收起功能

    React实现复杂搜索表单的展开收起功能

    本节对于需要展开收起效果的查询表单进行概述,主要涉及前端样式知识。对React实现复杂搜索表单的展开-收起功能感兴趣的朋友一起看看吧
    2021-09-09
  • ReactJS中的自定义组件实例代码

    ReactJS中的自定义组件实例代码

    React 是一个用于构建用户界面的 JAVASCRIPT 库。这篇文章主要介绍了ReactJS中的自定义组件的代码讲解,需要的朋友可以参考下
    2019-11-11
  • React 使用recharts实现散点地图的示例代码

    React 使用recharts实现散点地图的示例代码

    这篇文章主要介绍了React 使用recharts实现散点地图的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • React中使用Workbox进行预缓存的实现代码

    React中使用Workbox进行预缓存的实现代码

    Workbox是Google Chrome团队推出的一套 PWA 的解决方案,这套解决方案当中包含了核心库和构建工具,因此我们可以利用Workbox实现Service Worker的快速开发,本文小编给大家介绍了React中使用Workbox进行预缓存的实现,需要的朋友可以参考下
    2023-11-11

最新评论