Skip to content

angular-virtual.md

Latest commit

 

History

History
34 lines (27 loc) · 1.06 KB

angular-virtual.md

File metadata and controls

34 lines (27 loc) · 1.06 KB
Raw
title Angular Virtual

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

injectVirtualizer

function injectVirtualizer<TScrollElement, TItemElement = unknown>(
  options: PartialKeys<
    Omit<VirtualizerOptions<TScrollElement, TItemElement>, 'getScrollElement'>,
    'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
  > & { scrollElement: ElementRef<TScrollElement> | TScrollElement | undefined },
): AngularVirtualizer<TScrollElement, TItemElement>

This function returns an AngularVirtualizer instance configured to work with an HTML element as the scrollElement.

injectWindowVirtualizer

function injectWindowVirtualizer<TItemElement = unknown>(
  options: PartialKeys<
    VirtualizerOptions<Window, TItemElement>,
    | 'getScrollElement'
    | 'observeElementRect'
    | 'observeElementOffset'
    | 'scrollToFn'
  >,
): AngularVirtualizer<Window, TItemElement>

This function returns a window-based AngularVirtualizer instance configured to work with the window as the scrollElement.