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

angular-virtual.md

34 lines1.1 KB

1---
2title: Angular Virtual
3---
4​
5The `@tanstack/angular-virtual` adapter is a wrapper around the core virtual logic.
6​
7## `injectVirtualizer`
8​
9```ts
10function injectVirtualizer<TScrollElement, TItemElement = unknown>(
11 options: PartialKeys<
12 Omit<VirtualizerOptions<TScrollElement, TItemElement>, 'getScrollElement'>,
13 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
14 > & { scrollElement: ElementRef<TScrollElement> | TScrollElement | undefined },
15): AngularVirtualizer<TScrollElement, TItemElement>
16```
17​
18This function returns an `AngularVirtualizer` instance configured to work with an HTML element as the scrollElement.
19​
20## `injectWindowVirtualizer`
21​
22```ts
23function injectWindowVirtualizer<TItemElement = unknown>(
24 options: PartialKeys<
25 VirtualizerOptions<Window, TItemElement>,
26 | 'getScrollElement'
27 | 'observeElementRect'
28 | 'observeElementOffset'
29 | 'scrollToFn'
30 >,
31): AngularVirtualizer<Window, TItemElement>
32```
33​
34This function returns a window-based `AngularVirtualizer` instance configured to work with the window as the scrollElement.