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 {
11 computed,
12 onScopeDispose,
13 shallowRef,
14 triggerRef,
15 unref,
16 watch,
17} from 'vue'
18import type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'
19import type { Ref } from 'vue'
20β
21export * from '@tanstack/virtual-core'
22β
23type MaybeRef<T> = T | Ref<T>
24β
25function useVirtualizerBase<
26 TScrollElement extends Element | Window,
27 TItemElement extends Element,
28>(
29 options: MaybeRef<VirtualizerOptions<TScrollElement, TItemElement>>,
30): Ref<Virtualizer<TScrollElement, TItemElement>> {
31 const virtualizer = new Virtualizer(unref(options))
32 const state = shallowRef(virtualizer)
33β
34 const cleanup = virtualizer._didMount()
35β
36 watch(
37 () => unref(options).getScrollElement(),
38 (el) => {
39 if (el) {
40 virtualizer._willUpdate()
41 }
42 },
43 {
44 immediate: true,
45 },
46 )
47β
48 watch(
49 () => unref(options),
50 (options) => {
51 virtualizer.setOptions({
52 ...options,
53 onChange: (instance, sync) => {
54 triggerRef(state)
55 options.onChange?.(instance, sync)
56 },
57 })
58β
59 virtualizer._willUpdate()
60 triggerRef(state)
61 },
62 {
63 immediate: true,
64 },
65 )
66β
67 onScopeDispose(cleanup)
68β
69 return state
70}
71β
72export function useVirtualizer<
73 TScrollElement extends Element,
74 TItemElement extends Element,
75>(
76 options: MaybeRef<
77 PartialKeys<
78 VirtualizerOptions<TScrollElement, TItemElement>,
79 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
80 >
81 >,
82): Ref<Virtualizer<TScrollElement, TItemElement>> {
83 return useVirtualizerBase<TScrollElement, TItemElement>(
84 computed(() => ({
85 observeElementRect: observeElementRect,
86 observeElementOffset: observeElementOffset,
87 scrollToFn: elementScroll,
88 ...unref(options),
89 })),
90 )
91}
92β
93export function useWindowVirtualizer<TItemElement extends Element>(
94 options: MaybeRef<
95 PartialKeys<
96 VirtualizerOptions<Window, TItemElement>,
97 | 'observeElementRect'
98 | 'observeElementOffset'
99 | 'scrollToFn'
100 | 'getScrollElement'
101 >
102 >,
103): Ref<Virtualizer<Window, TItemElement>> {
104 return useVirtualizerBase<Window, TItemElement>(
105 computed(() => ({
106 getScrollElement: () => (typeof document !== 'undefined' ? window : null),
107 observeElementRect: observeWindowRect,
108 observeElementOffset: observeWindowOffset,
109 scrollToFn: windowScroll,
110 initialOffset: () =>
111 typeof document !== 'undefined' ? window.scrollY : 0,
112 ...unref(options),
113 })),
114 )
115}