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'
10import { derived, writable } from 'svelte/store'
11import type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'
12import type { Readable, Writable } from 'svelte/store'
13β
14export * from '@tanstack/virtual-core'
15β
16export type SvelteVirtualizer<
17 TScrollElement extends Element | Window,
18 TItemElement extends Element,
19> = Omit<Virtualizer<TScrollElement, TItemElement>, 'setOptions'> & {
20 setOptions: (
21 options: Partial<VirtualizerOptions<TScrollElement, TItemElement>>,
22 ) => void
23}
24β
25function createVirtualizerBase<
26 TScrollElement extends Element | Window,
27 TItemElement extends Element,
28>(
29 initialOptions: VirtualizerOptions<TScrollElement, TItemElement>,
30): Readable<SvelteVirtualizer<TScrollElement, TItemElement>> {
31 const virtualizer = new Virtualizer(initialOptions)
32 const originalSetOptions = virtualizer.setOptions
33β
34 // eslint-disable-next-line prefer-const
35 let virtualizerWritable: Writable<Virtualizer<TScrollElement, TItemElement>>
36β
37 const setOptions = (
38 options: Partial<VirtualizerOptions<TScrollElement, TItemElement>>,
39 ) => {
40 const resolvedOptions = {
41 ...virtualizer.options,
42 ...options,
43 onChange: options.onChange,
44 }
45 originalSetOptions({
46 ...resolvedOptions,
47 onChange: (
48 instance: Virtualizer<TScrollElement, TItemElement>,
49 sync: boolean,
50 ) => {
51 virtualizerWritable.set(instance)
52 resolvedOptions.onChange?.(instance, sync)
53 },
54 })
55 virtualizer._willUpdate()
56 }
57β
58 virtualizerWritable = writable(virtualizer, () => {
59 setOptions(initialOptions)
60 return virtualizer._didMount()
61 })
62β
63 return derived(virtualizerWritable, (instance) =>
64 Object.assign(instance, { setOptions }),
65 )
66}
67β
68export function createVirtualizer<
69 TScrollElement extends Element,
70 TItemElement extends Element,
71>(
72 options: PartialKeys<
73 VirtualizerOptions<TScrollElement, TItemElement>,
74 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
75 >,
76): Readable<SvelteVirtualizer<TScrollElement, TItemElement>> {
77 return createVirtualizerBase<TScrollElement, TItemElement>({
78 observeElementRect: observeElementRect,
79 observeElementOffset: observeElementOffset,
80 scrollToFn: elementScroll,
81 ...options,
82 })
83}
84β
85export function createWindowVirtualizer<TItemElement extends Element>(
86 options: PartialKeys<
87 VirtualizerOptions<Window, TItemElement>,
88 | 'getScrollElement'
89 | 'observeElementRect'
90 | 'observeElementOffset'
91 | 'scrollToFn'
92 >,
93): Readable<SvelteVirtualizer<Window, TItemElement>> {
94 return createVirtualizerBase<Window, TItemElement>({
95 getScrollElement: () => (typeof document !== 'undefined' ? window : null),
96 observeElementRect: observeWindowRect,
97 observeElementOffset: observeWindowOffset,
98 scrollToFn: windowScroll,
99 initialOffset: () => (typeof document !== 'undefined' ? window.scrollY : 0),
100 ...options,
101 })
102}