Open History to see the last commit
1---
2title: Angular Virtual
3---
4β
5The `@tanstack/angular-virtual` adapter is a wrapper around the core virtual logic.
6β
7Angular Virtual supports Angular 19 and newer. In practice, the adapter is intended to support Angular LTS releases and newer.
8β
9## `injectVirtualizer`
10β
11```ts
12function injectVirtualizer<TScrollElement, TItemElement = unknown>(
13 options: PartialKeys<
14 Omit<VirtualizerOptions<TScrollElement, TItemElement>, 'getScrollElement'>,
15 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
16 > & { scrollElement: ElementRef<TScrollElement> | TScrollElement | undefined },
17): AngularVirtualizer<TScrollElement, TItemElement>
18```
19β
20This function returns an `AngularVirtualizer` instance configured to work with an HTML element as the scrollElement.
21The returned `AngularVirtualizer` mirrors the core `Virtualizer`, but adapter-managed state is exposed through Angular signals. This includes:
22β
23- `getTotalSize`
24- `getVirtualItems`
25- `isScrolling`
26- `options`
27- `range`
28- `scrollDirection`
29- `scrollElement`
30- `scrollOffset`
31- `scrollRect`
32- `measurementsCache`
33β
34## `injectWindowVirtualizer`
35β
36```ts
37function injectWindowVirtualizer<TItemElement = unknown>(
38 options: PartialKeys<
39 VirtualizerOptions<Window, TItemElement>,
40 | 'getScrollElement'
41 | 'observeElementRect'
42 | 'observeElementOffset'
43 | 'scrollToFn'
44 >,
45): AngularVirtualizer<Window, TItemElement>
46```
47β
48This function returns a window-based `AngularVirtualizer` instance configured to work with the window as the scrollElement.