Files
otunes/apps/web/components/virtual-list.tsx
T

121 lines
3.2 KiB
TypeScript

"use client"
import * as React from "react"
import {
defaultRangeExtractor,
useVirtualizer,
type Range,
} from "@tanstack/react-virtual"
import { cn } from "@/lib/utils"
const scrollViewportSelector = '[data-slot="scroll-area-viewport"]'
/**
* Renders only the visible items of a list placed inside a `ScrollArea`.
* The list may sit below other content in the same viewport.
*/
export function VirtualList({
count,
estimateSize,
getItemKey,
renderItem,
overscan = 10,
keepMounted = null,
className,
}: {
count: number
estimateSize: (index: number) => number
getItemKey: (index: number) => string
renderItem: (index: number) => React.ReactNode
overscan?: number
/** Index rendered even when off screen, e.g. the source of a drag. */
keepMounted?: number | null
className?: string
}) {
const listRef = React.useRef<HTMLDivElement>(null)
const [scrollMargin, setScrollMargin] = React.useState(0)
React.useLayoutEffect(() => {
const list = listRef.current
const viewport = list?.closest<HTMLElement>(scrollViewportSelector)
if (!list || !viewport) return
const measure = () => {
setScrollMargin(
Math.round(
list.getBoundingClientRect().top -
viewport.getBoundingClientRect().top +
viewport.scrollTop
)
)
}
const observer = new ResizeObserver(measure)
observer.observe(viewport)
if (viewport.firstElementChild) {
observer.observe(viewport.firstElementChild)
}
return () => observer.disconnect()
}, [])
const getScrollElement = () =>
listRef.current?.closest<HTMLElement>(scrollViewportSelector) ?? null
const virtualizer = useVirtualizer({
count,
getScrollElement,
// The virtualizer scrolls to this offset on attach. Keep the viewport's
// current position so `ScrollRestoration` is not reset to the top.
initialOffset: () => getScrollElement()?.scrollTop ?? 0,
estimateSize,
getItemKey,
overscan,
scrollMargin,
rangeExtractor: React.useCallback(
(range: Range) => {
const indexes = defaultRangeExtractor(range)
if (
keepMounted !== null &&
keepMounted < range.count &&
!indexes.includes(keepMounted)
) {
indexes.push(keepMounted)
indexes.sort((a, b) => a - b)
}
return indexes
},
[keepMounted]
),
})
// The virtualizer caches its offset across a detach. Clear it so a
// re-attach (e.g. StrictMode's effect replay) re-reads `initialOffset`
// instead of scrolling back to a stale position.
React.useLayoutEffect(
() => () => {
virtualizer.scrollOffset = null
},
[virtualizer]
)
return (
<div
ref={listRef}
className={cn("relative w-full", className)}
style={{ height: virtualizer.getTotalSize() }}
>
{virtualizer.getVirtualItems().map((item) => (
<div
key={item.key}
data-index={item.index}
ref={virtualizer.measureElement}
className="absolute top-0 left-0 w-full"
style={{ transform: `translateY(${item.start - scrollMargin}px)` }}
>
{renderItem(item.index)}
</div>
))}
</div>
)
}