Open History to see the last commit
1import {
2 Virtualizer,
3 elementScroll,
4 observeElementOffset,
5 observeElementRect,
6 observeWindowOffset,
7 observeWindowRect,
8 windowScroll,
9} from '@tanstack/virtual-core'
10β
11import {
12 createComputed,
13 createSignal,
14 mergeProps,
15 onCleanup,
16 onMount,
17} from 'solid-js'
18import { createStore, reconcile } from 'solid-js/store'
19import type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'
20β
21export * from '@tanstack/virtual-core'
22β
23function createVirtualizerBase<
24 TScrollElement extends Element | Window,
25 TItemElement extends Element,
26>(
27 options: VirtualizerOptions<TScrollElement, TItemElement>,
28): Virtualizer<TScrollElement, TItemElement> {
29 const resolvedOptions: VirtualizerOptions<TScrollElement, TItemElement> =
30 mergeProps(options)
31β
32 const instance = new Virtualizer<TScrollElement, TItemElement>(
33 resolvedOptions,
34 )
35β
36 const [virtualItems, setVirtualItems] = createStore(
37 instance.getVirtualItems(),
38 )
39 const [totalSize, setTotalSize] = createSignal(instance.getTotalSize())
40β
41 const handler = {
42 get(
43 target: Virtualizer<TScrollElement, TItemElement>,
44 prop: keyof Virtualizer<TScrollElement, TItemElement>,
45 ) {
46 switch (prop) {
47 case 'getVirtualItems':
48 return () => virtualItems
49 case 'getTotalSize':
50 return () => totalSize()
51 default:
52 return Reflect.get(target, prop)
53 }
54 },
55 }
56β
57 const virtualizer = new Proxy(instance, handler)
58 virtualizer.setOptions(resolvedOptions)
59β
60 onMount(() => {
61 const cleanup = virtualizer._didMount()
62 virtualizer._willUpdate()
63 onCleanup(cleanup)
64 })
65β
66 createComputed(() => {
67 virtualizer.setOptions(
68 mergeProps(resolvedOptions, options, {
69 onChange: (
70 instance: Virtualizer<TScrollElement, TItemElement>,
71 sync: boolean,
72 ) => {
73 instance._willUpdate()
74 setVirtualItems(
75 reconcile(instance.getVirtualItems(), {
76 key: 'index',
77 }),
78 )
79 setTotalSize(instance.getTotalSize())
80 options.onChange?.(instance, sync)
81 },
82 }),
83 )
84 virtualizer.measure()
85 })
86β
87 return virtualizer
88}
89β
90export function createVirtualizer<
91 TScrollElement extends Element,
92 TItemElement extends Element,
93>(
94 options: PartialKeys<
95 VirtualizerOptions<TScrollElement, TItemElement>,
96 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
97 >,
98): Virtualizer<TScrollElement, TItemElement> {
99 return createVirtualizerBase<TScrollElement, TItemElement>(
100 mergeProps(
101 {
102 observeElementRect: observeElementRect,
103 observeElementOffset: observeElementOffset,
104 scrollToFn: elementScroll,
105 },
106 options,
107 ),
108 )
109}
110β
111export function createWindowVirtualizer<TItemElement extends Element>(
112 options: PartialKeys<
113 VirtualizerOptions<Window, TItemElement>,
114 | 'getScrollElement'
115 | 'observeElementRect'
116 | 'observeElementOffset'
117 | 'scrollToFn'
118 >,
119): Virtualizer<Window, TItemElement> {
120 return createVirtualizerBase<Window, TItemElement>(
121 mergeProps(
122 {
123 getScrollElement: () =>
124 typeof document !== 'undefined' ? window : null,
125 observeElementRect: observeWindowRect,
126 observeElementOffset: observeWindowOffset,
127 scrollToFn: windowScroll,
128 initialOffset: () =>
129 typeof document !== 'undefined' ? window.scrollY : 0,
130 },
131 options,
132 ),
133 )
134}