kotlin-tanstack-virtual-core/tanstack.virtual.core/Virtualizer

Virtualizer

external class Virtualizer<TScrollElement : EventTarget, TItemElement : Element>(source)

Constructors

constructor(opts: VirtualizerOptions<TScrollElement, TItemElement>)

Properties

external var calculateRange: Updatable<ItemRange?, Tuple4<ReadonlyArray<VirtualItem>, Int, Int, Int>>

external var elementsCache: ReadonlyMap<Key, TItemElement>

getDistanceFromEnd

external var getDistanceFromEnd: () -> Int

getOffsetForAlignment

external var getOffsetForAlignment: (toOffset: Int, align: ScrollAlignment, itemSize: Int?) -> Int

getOffsetForIndex

external var getOffsetForIndex: (index: Int, align: ScrollAlignment?) -> Tuple2<Double, ScrollAlignment>

external var getTotalSize: () -> Int

getVirtualIndexes

external var getVirtualIndexes: Updatable<ReadonlyArray<Int>, Tuple5<(range: Range) -> ReadonlyArray<Int>, Int, Int, Int?, Int?>>

getVirtualItemForOffset

external var getVirtualItemForOffset: (offset: Int) -> VirtualItem

getVirtualItems

external var getVirtualItems: Updatable<ReadonlyArray<VirtualItem>, Tuple2<ReadonlyArray<Int>, ReadonlyArray<VirtualItem>>>

indexFromElement

external var indexFromElement: (node: TItemElement) -> Int

external var isAtEnd: (threshold: Int?) -> Boolean

external var isScrolling: Boolean

external var itemSizeCache: ReadonlyMap<Key, Int>

external var measure: () -> Unit

external var measureElement: (node: TItemElement?) -> Unit

measurementsCache

external var measurementsCache: ReadonlyArray<VirtualItem>

external var options: VirtualizerOptions<TScrollElement, TItemElement>

external var range: ItemRange?

external var resizeItem: (index: Int, size: Int) -> Unit

scrollAdjustments

external var scrollAdjustments: Int

external var scrollBy: (delta: Int, ScrollToOffsetOptions?) -> Unit

scrollDirection

external var scrollDirection: ScrollDirection?

external var scrollElement: TScrollElement?

external var scrollOffset: Int?

external var scrollRect: Rect?

external var scrollToEnd: (options: ScrollToEndOptions?) -> Unit

external var scrollToIndex: (index: Int, ScrollToIndexOptions?) -> Unit

external var scrollToOffset: (toOffset: Int, ScrollToOffsetOptions?) -> Unit

external var setOptions: (opts: VirtualizerOptions<TScrollElement, TItemElement>) -> Unit

shouldAdjustScrollPositionOnItemSizeChange

external var shouldAdjustScrollPositionOnItemSizeChange: (item: VirtualItem, delta: Int, instance: Virtualizer<TScrollElement, TItemElement>) -> Boolean?

external var takeSnapshot: () -> ReadonlyArray<VirtualItem>

Returns a snapshot of currently-measured items suitable for round- tripping through state storage (sessionStorage, history, etc.) and passing back as initialMeasurementsCache on remount. Pair with the current scrollOffset to restore exact scroll position after navigation.

external var targetWindow: Window?