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

lit-virtual.md

36 lines1.1 KB

The @tanstack/lit-virtual adapter is a wrapper around the core virtual logic.

createVirtualizer


private virtualizerController = new VirtualizerController<TScrollElement, TItemElement = unknown>(
    options: PartialKeys< VirtualizerOptions<TScrollElement, TItemElement>,
    'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
)

This class stands for a standard Virtualizer instance configured to work with an HTML element as the scrollElement. This will create a Lit Controller which can be accessed in the element render method.

render() {
    const virtualizer = this.virtualizerController.getVirtualizer();
    const virtualItems = virtualizer.getVirtualItems();
} 
)

createWindowVirtualizer

private windowVirtualizerController = new WindowVirtualizerController<TItemElement = unknown>(
    options: PartialKeys< VirtualizerOptions<TItemElement>,
    'getScrollElement' | 'observeElementRect' | 'observeElementOffset' | 'scrollToFn'

This class stands of window-based Virtualizer instance configured to work with an HTML element as the scrollElement.