160 lines
4.4 KiB
TypeScript
160 lines
4.4 KiB
TypeScript
import type { Ref } from 'vue'
|
|
import { computed, ref, watch, watchEffect } from 'vue'
|
|
|
|
export interface VirtualScrollOptions {
|
|
itemHeight: number
|
|
bufferSize?: number
|
|
enabled?: Ref<boolean>
|
|
onNearEnd?: () => void
|
|
nearEndThreshold?: number
|
|
}
|
|
|
|
export function useVirtualScroll<T>(items: Ref<T[]>, options: VirtualScrollOptions) {
|
|
const { itemHeight, bufferSize = 5, enabled, onNearEnd, nearEndThreshold = 0.2 } = options
|
|
|
|
const listContainer = ref<HTMLElement | null>(null)
|
|
const scrollContainer = ref<HTMLElement | Window | null>(null)
|
|
const scrollTop = ref(0)
|
|
const viewportHeight = ref(0)
|
|
const containerOffset = ref(0)
|
|
|
|
const totalHeight = computed(() => items.value.length * itemHeight)
|
|
|
|
function findScrollableAncestor(element: HTMLElement | null): HTMLElement | Window {
|
|
if (!element) return window
|
|
|
|
let current: HTMLElement | null = element.parentElement
|
|
while (current) {
|
|
const { overflowY } = getComputedStyle(current)
|
|
if (overflowY === 'auto' || overflowY === 'scroll') {
|
|
return current
|
|
}
|
|
current = current.parentElement
|
|
}
|
|
return window
|
|
}
|
|
|
|
function getScrollTop(container: HTMLElement | Window): number {
|
|
return container instanceof Window ? window.scrollY : container.scrollTop
|
|
}
|
|
|
|
function getViewportHeight(container: HTMLElement | Window): number {
|
|
return container instanceof Window ? window.innerHeight : container.clientHeight
|
|
}
|
|
|
|
function updateContainerOffset() {
|
|
const listEl = listContainer.value
|
|
const container = scrollContainer.value
|
|
if (!listEl || !container) return
|
|
|
|
if (container instanceof Window) {
|
|
containerOffset.value = listEl.getBoundingClientRect().top + window.scrollY
|
|
} else {
|
|
const listRect = listEl.getBoundingClientRect()
|
|
const containerRect = container.getBoundingClientRect()
|
|
containerOffset.value = listRect.top - containerRect.top + container.scrollTop
|
|
}
|
|
}
|
|
|
|
function syncScrollState() {
|
|
if (!scrollContainer.value) return
|
|
scrollTop.value = getScrollTop(scrollContainer.value)
|
|
viewportHeight.value = getViewportHeight(scrollContainer.value)
|
|
updateContainerOffset()
|
|
}
|
|
|
|
const visibleRange = computed(() => {
|
|
if (enabled && !enabled.value) {
|
|
return { start: 0, end: items.value.length }
|
|
}
|
|
|
|
if (!listContainer.value || !scrollContainer.value) return { start: 0, end: 0 }
|
|
|
|
const relativeScrollTop = Math.max(0, scrollTop.value - containerOffset.value)
|
|
|
|
const start = Math.floor(relativeScrollTop / itemHeight)
|
|
const visibleCount = Math.ceil(viewportHeight.value / itemHeight)
|
|
|
|
const rangeStart = Math.max(0, start - bufferSize)
|
|
const rangeEnd = Math.min(items.value.length, start + visibleCount + bufferSize * 2)
|
|
|
|
return {
|
|
start: rangeStart,
|
|
end: rangeEnd,
|
|
}
|
|
})
|
|
|
|
const visibleTop = computed(() =>
|
|
enabled && !enabled.value ? 0 : visibleRange.value.start * itemHeight,
|
|
)
|
|
|
|
const visibleItems = computed(() =>
|
|
items.value.slice(visibleRange.value.start, visibleRange.value.end),
|
|
)
|
|
|
|
function checkNearEnd() {
|
|
if (!onNearEnd || !listContainer.value || !viewportHeight.value) return
|
|
|
|
const containerBottom = listContainer.value.getBoundingClientRect().bottom
|
|
const remainingScroll = containerBottom - viewportHeight.value
|
|
|
|
if (remainingScroll < viewportHeight.value * nearEndThreshold) {
|
|
onNearEnd()
|
|
}
|
|
}
|
|
|
|
function handleScroll() {
|
|
if (scrollContainer.value) {
|
|
scrollTop.value = getScrollTop(scrollContainer.value)
|
|
updateContainerOffset()
|
|
}
|
|
checkNearEnd()
|
|
}
|
|
|
|
function handleResize() {
|
|
syncScrollState()
|
|
}
|
|
|
|
// Re-sync scroll state when items change to avoid stale scrollTop/offset
|
|
watch(items, () => {
|
|
syncScrollState()
|
|
})
|
|
|
|
watchEffect((onCleanup) => {
|
|
if (typeof window === 'undefined') return
|
|
|
|
const listEl = listContainer.value
|
|
if (!listEl) return
|
|
|
|
const container = findScrollableAncestor(listEl)
|
|
scrollContainer.value = container
|
|
syncScrollState()
|
|
|
|
container.addEventListener('scroll', handleScroll, { passive: true })
|
|
window.addEventListener('resize', handleResize, { passive: true })
|
|
|
|
// Use ResizeObserver for element scroll containers
|
|
let resizeObserver: ResizeObserver | undefined
|
|
if (!(container instanceof Window)) {
|
|
resizeObserver = new ResizeObserver(() => {
|
|
syncScrollState()
|
|
})
|
|
resizeObserver.observe(container)
|
|
}
|
|
|
|
onCleanup(() => {
|
|
container.removeEventListener('scroll', handleScroll)
|
|
window.removeEventListener('resize', handleResize)
|
|
resizeObserver?.disconnect()
|
|
})
|
|
})
|
|
|
|
return {
|
|
listContainer,
|
|
totalHeight,
|
|
visibleRange,
|
|
visibleTop,
|
|
visibleItems,
|
|
}
|
|
}
|