Open History to see the last commit
1import * as React from 'react'
2import { flushSync } from 'react-dom'
3import {
4 Virtualizer,
5 elementScroll,
6 observeElementOffset,
7 observeElementRect,
8 observeWindowOffset,
9 observeWindowRect,
10 windowScroll,
11} from '@tanstack/virtual-core'
12import type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'
13β
14export * from '@tanstack/virtual-core'
15β
16const useIsomorphicLayoutEffect =
17 typeof document !== 'undefined' ? React.useLayoutEffect : React.useEffect
18β
19function useVirtualizerBase<
20 TScrollElement extends Element | Window,
21 TItemElement extends Element,
22>(
23 options: VirtualizerOptions<TScrollElement, TItemElement>,
24): Virtualizer<TScrollElement, TItemElement> {
25 const rerender = React.useReducer(() => ({}), {})[1]
26β
27 const resolvedOptions: VirtualizerOptions<TScrollElement, TItemElement> = {
28 ...options,
29 onChange: (instance, sync) => {
30 if (sync) {
31 flushSync(rerender)
32 } else {
33 rerender()
34 }
35 options.onChange?.(instance, sync)
36 },
37 }
38β
39 const [instance] = React.useState(
40 () => new Virtualizer<TScrollElement, TItemElement>(resolvedOptions),
41 )
42β
43 instance.setOptions(resolvedOptions)
44β
45 useIsomorphicLayoutEffect(() => {
46 return instance._didMount()
47 }, [])
48β
49 useIsomorphicLayoutEffect(() => {
50 return instance._willUpdate()
51 })
52β
53 return React.useMemo(
54 () => Object.create(instance),
55 [instance.getVirtualItems()],
56 )
57}
58β
59export function useVirtualizer<
60 TScrollElement extends Element,
61 TItemElement extends Element,
62>(
63 options: PartialKeys<
64 VirtualizerOptions<TScrollElement, TItemElement>,
65 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
66 >,
67): Virtualizer<TScrollElement, TItemElement> {
68 return useVirtualizerBase<TScrollElement, TItemElement>({
69 observeElementRect: observeElementRect,
70 observeElementOffset: observeElementOffset,
71 scrollToFn: elementScroll,
72 ...options,
73 })
74}
75β
76export function useWindowVirtualizer<TItemElement extends Element>(
77 options: PartialKeys<
78 VirtualizerOptions<Window, TItemElement>,
79 | 'getScrollElement'
80 | 'observeElementRect'
81 | 'observeElementOffset'
82 | 'scrollToFn'
83 >,
84): Virtualizer<Window, TItemElement> {
85 return useVirtualizerBase<Window, TItemElement>({
86 getScrollElement: () => (typeof document !== 'undefined' ? window : null),
87 observeElementRect: observeWindowRect,
88 observeElementOffset: observeWindowOffset,
89 scrollToFn: windowScroll,
90 initialOffset: () => (typeof document !== 'undefined' ? window.scrollY : 0),
91 ...options,
92 })
93}