Skip to content
Source
Sign inSign up
TanStack/virtual
Open History to see the last commit

index.ts

141 lines4.0 KB

1import {
2 AfterRenderPhase,
3 DestroyRef,
4 afterNextRender,
5 computed,
6 effect,
7 inject,
8 signal,
9 untracked,
10} from '@angular/core'
11import {
12 Virtualizer,
13 elementScroll,
14 observeElementOffset,
15 observeElementRect,
16 observeWindowOffset,
17 observeWindowRect,
18 windowScroll,
19} from '@tanstack/virtual-core'
20import { proxyVirtualizer } from './proxy'
21import type { ElementRef, Signal } from '@angular/core'
22import type { PartialKeys, VirtualizerOptions } from '@tanstack/virtual-core'
23import type { AngularVirtualizer } from './types'
24​
25export * from '@tanstack/virtual-core'
26export * from './types'
27​
28function createVirtualizerBase<
29 TScrollElement extends Element | Window,
30 TItemElement extends Element,
31>(
32 options: Signal<VirtualizerOptions<TScrollElement, TItemElement>>,
33): AngularVirtualizer<TScrollElement, TItemElement> {
34 let virtualizer: Virtualizer<TScrollElement, TItemElement>
35 function lazyInit() {
36 virtualizer ??= new Virtualizer(options())
37 return virtualizer
38 }
39​
40 const virtualizerSignal = signal(virtualizer!, { equal: () => false })
41​
42 // two-way sync options
43 effect(
44 () => {
45 const _options = options()
46 lazyInit()
47 virtualizerSignal.set(virtualizer)
48 virtualizer.setOptions({
49 ..._options,
50 onChange: (instance, sync) => {
51 // update virtualizerSignal so that dependent computeds recompute.
52 virtualizerSignal.set(instance)
53 _options.onChange?.(instance, sync)
54 },
55 })
56 // update virtualizerSignal so that dependent computeds recompute.
57 virtualizerSignal.set(virtualizer)
58 },
59 { allowSignalWrites: true },
60 )
61​
62 const scrollElement = computed(() => options().getScrollElement())
63 // let the virtualizer know when the scroll element is changed
64 effect(
65 () => {
66 const el = scrollElement()
67 if (el) {
68 untracked(virtualizerSignal)._willUpdate()
69 }
70 },
71 { allowSignalWrites: true },
72 )
73​
74 let cleanup: () => void | undefined
75 afterNextRender(() => (virtualizer ?? lazyInit())._didMount(), {
76 phase: AfterRenderPhase.Read,
77 })
78​
79 inject(DestroyRef).onDestroy(() => cleanup?.())
80​
81 return proxyVirtualizer(virtualizerSignal, lazyInit)
83​
84export function injectVirtualizer<
85 TScrollElement extends Element,
86 TItemElement extends Element,
87>(
88 options: () => PartialKeys<
89 Omit<VirtualizerOptions<TScrollElement, TItemElement>, 'getScrollElement'>,
90 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
91 > & {
92 scrollElement: ElementRef<TScrollElement> | TScrollElement | undefined
93 },
94): AngularVirtualizer<TScrollElement, TItemElement> {
95 const resolvedOptions = computed(() => {
96 return {
97 observeElementRect: observeElementRect,
98 observeElementOffset: observeElementOffset,
99 scrollToFn: elementScroll,
100 getScrollElement: () => {
101 const elementOrRef = options().scrollElement
102 return (
103 (isElementRef(elementOrRef)
104 ? elementOrRef.nativeElement
105 : elementOrRef) ?? null
106 )
107 },
108 ...options(),
109 }
110 })
111 return createVirtualizerBase<TScrollElement, TItemElement>(resolvedOptions)
113​
114function isElementRef<T extends Element>(
115 elementOrRef: ElementRef<T> | T | undefined,
116): elementOrRef is ElementRef<T> {
117 return elementOrRef != null && 'nativeElement' in elementOrRef
119​
120export function injectWindowVirtualizer<TItemElement extends Element>(
121 options: () => PartialKeys<
122 VirtualizerOptions<Window, TItemElement>,
123 | 'getScrollElement'
124 | 'observeElementRect'
125 | 'observeElementOffset'
126 | 'scrollToFn'
127 >,
128): AngularVirtualizer<Window, TItemElement> {
129 const resolvedOptions = computed(() => {
130 return {
131 getScrollElement: () => (typeof document !== 'undefined' ? window : null),
132 observeElementRect: observeWindowRect,
133 observeElementOffset: observeWindowOffset,
134 scrollToFn: windowScroll,
135 initialOffset: () =>
136 typeof document !== 'undefined' ? window.scrollY : 0,
137 ...options(),
138 }
139 })
140 return createVirtualizerBase<Window, TItemElement>(resolvedOptions)