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

solid-virtual.md

34 lines958 Bytes

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