手写VueUse的useInfiniteScroll函数实现

以下是手写 useInfiniteScroll 函数的实现,用于实现无限滚动加载功能:

typescript 复制代码
import {
  ref,
  watch,
  onUnmounted,
  unref,
  type Ref,
  type ComponentPublicInstance
} from 'vue'

interface UseInfiniteScrollOptions {
  direction?: 'vertical' | 'horizontal'
  interval?: number
  immediate?: boolean
}

export function useInfiniteScroll(
  target: Ref<HTMLElement | ComponentPublicInstance | Window | null>,
  onLoad: () => Promise<void> | void,
  options: UseInfiniteScrollOptions = {}
) {
  const {
    direction = 'vertical',
    interval = 100,
    immediate = true
  } = options

  const isLoading = ref(false)
  const isFinished = ref(false)
  let lastTriggerTime = 0

  const getElement = (): HTMLElement | Window => {
    const el = unref(target)
    if (el instanceof Window) return window
    return (el as ComponentPublicInstance)?.$el ?? el
  }

  const checkInView = () => {
    if (isLoading.value || isFinished.value) return
    
    const el = getElement()
    if (!el || el instanceof Window) return checkWindowScroll()
    
    if (direction === 'vertical') {
      const { scrollTop, scrollHeight, clientHeight } = el as HTMLElement
      return scrollTop + clientHeight >= scrollHeight - 50
    } else {
      const { scrollLeft, scrollWidth, clientWidth } = el as HTMLElement
      return scrollLeft + clientWidth >= scrollWidth - 50
    }
  }

  const checkWindowScroll = () => {
    const { documentElement } = document
    if (direction === 'vertical') {
      return (
        window.innerHeight + documentElement.scrollTop >=
        documentElement.scrollHeight - 50
      )
    } else {
      return (
        window.innerWidth + documentElement.scrollLeft >=
        documentElement.scrollWidth - 50
      )
    }
  }

  const handleScroll = () => {
    if (Date.now() - lastTriggerTime < interval) return
    if (!checkInView()) return
    
    lastTriggerTime = Date.now()
    triggerLoad()
  }

  const triggerLoad = async () => {
    if (isLoading.value || isFinished.value) return
    
    isLoading.value = true
    try {
      const result = await onLoad()
      if (result === false) isFinished.value = true
    } finally {
      isLoading.value = false
    }
  }

  const addListener = () => {
    const el = getElement()
    if (el instanceof Window) {
      window.addEventListener('scroll', handleScroll)
    } else if (el) {
      el.addEventListener('scroll', handleScroll)
    }
  }

  const removeListener = () => {
    const el = getElement()
    if (el instanceof Window) {
      window.removeEventListener('scroll', handleScroll)
    } else if (el) {
      el.removeEventListener('scroll', handleScroll)
    }
  }

  watch(
    () => getElement(),
    (newEl, oldEl) => {
      removeListener()
      addListener()
    },
    { immediate: true }
  )

  const load = () => triggerLoad()

  onUnmounted(() => {
    removeListener()
  })

  // Immediate load
  if (immediate) {
    setTimeout(triggerLoad, 0)
  }

  return {
    isLoading,
    isFinished,
    load
  }
}

使用示例:

vue 复制代码
<template>
  <div ref="container" class="scroll-container">
    <div v-for="item in items" :key="item.id">{{ item.content }}</div>
    <div v-if="isLoading">Loading...</div>
    <div v-if="isFinished">No more data</div>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue'
import { useInfiniteScroll } from './useInfiniteScroll'

const container = ref<HTMLElement | null>(null)
const items = ref<any[]>([])
let page = 1

const { isLoading, isFinished, load } = useInfiniteScroll(
  container,
  async () => {
    const newData = await fetchData(page)
    if (newData.length === 0) return false
    items.value.push(...newData)
    page++
  },
  { immediate: true }
)

async function fetchData(p: number) {
  // 模拟API请求
  return new Array(10).fill(null).map((_, i) => ({
    id: (p - 1) * 10 + i,
    content: `Item ${(p - 1) * 10 + i + 1}`
  }))
}
</script>

<style>
.scroll-container {
  height: 500px;
  overflow-y: auto;
}
</style>

实现细节说明:

  1. 核心功能

    • 自动检测滚动到底部时触发加载
    • 支持垂直/水平滚动方向
    • 内置防抖机制(通过interval参数控制)
  2. 响应式状态

    • isLoading: 加载状态指示
    • isFinished: 数据是否全部加载完成
  3. 滚动检测逻辑

    • 自动适配普通元素和window的滚动容器
    • 智能计算滚动位置(距底部50px触发)
    • 支持自定义检测间隔(默认100ms)
  4. 生命周期管理

    • 自动清理事件监听器
    • 支持动态切换目标元素
    • 组件卸载时自动移除监听
  5. 扩展功能

    • 支持立即执行首次加载(immediate参数)
    • 提供手动触发方法(load())
    • 支持通过返回false终止加载
  6. 类型安全

    • 完整TypeScript类型支持
    • 兼容Vue组件实例和原生DOM元素
    • 支持Window对象的滚动监听

参数说明:

参数 类型 说明
target Ref<HTMLElement | Window> 滚动容器元素引用
onLoad () => Promise | void 加载回调函数
options UseInfiniteScrollOptions 配置选项

选项参数:

属性 类型 默认值 说明
direction 'vertical'/'horizontal' 'vertical' 滚动方向
interval number 100 触发间隔(毫秒)
immediate boolean true 是否立即执行首次加载

该实现提供了与VueUse相似的功能,同时保留了以下特性:

  • 自动处理组件卸载时的资源清理
  • 完善的TypeScript类型支持
  • 灵活的滚动容器支持(包括Vue组件实例)
  • 可配置的触发策略和加载控制
相关推荐
F2E_Zhangmo2 小时前
基于cornerstone3D的dicom影像浏览器 第三章 拖拽seriesItem至displayer上显示第一张dicom
前端·javascript·cornerstone·cornerstone3d·cornerstonejs
gnip7 小时前
Jst执行上下文栈和变量对象
前端·javascript
excel7 小时前
🐣 最简单的卷积与激活函数指南(带示例)
前端
醉方休7 小时前
npm/pnpm软链接的优点和使用场景
前端·npm·node.js
拉不动的猪7 小时前
简单回顾下Weakmap在vue中为何不能去作为循环数据源,以及替代方案
前端·javascript·vue.js
How_doyou_do8 小时前
数据传输优化-异步不阻塞处理增强首屏体验
开发语言·前端·javascript
奇舞精选8 小时前
超越Siri的耳朵:ASR与Whisper零代码部署实战指南
前端·人工智能·aigc
奇舞精选8 小时前
Nano Banana 如何为前端注入 AI 控制力
前端·aigc
一支鱼8 小时前
基于 Node.js 的短视频制作神器 ——FFCreator
前端·node.js·音视频开发
DT——8 小时前
前端登录鉴权详解
前端·javascript