core

Framework-independent model and DOM primitives for efficiently rendering large scrollable data sets with dynamic item sizes.

Installation

npm install @af-utils/virtual-core

Use this package directly when building a custom renderer or framework adapter. Applications can normally use one of the framework-specific packages instead.

Documentation

• Virtual scrolling overview
• Custom rendering guide
• Layout elements guide
• Support and compatibility
• API reference

Core framework-agnostic model.

Remarks

What it does:

• stores item sizes and positions;

• tracks elements resizing;

• provides performant way to calculate offsets;

• deals with scrolling to item index or to offset;

• emits and allows subscriptions to VirtualScrollerEvent flags.

What it doesn’t do:

• rendering;

• styling;

• all other framework-related stuff.

Classes

• VirtualScroller
• VirtualScrollerError
• VirtualScrollerLayout

Interfaces

• VirtualScrollerInitialParams
• VirtualScrollerRuntimeParams
• VirtualScrollerScrollToIndexOptions

Type Aliases

• VirtualScrollerErrorCode
• VirtualScrollerEvent
• VirtualScrollerEventMask
• VirtualScrollerExactPosition
• VirtualScrollerScrollAlignment
• VirtualScrollerScrollElement

Variables

• VirtualScrollerErrorCode
• VirtualScrollerEvent

Functions

• mapVirtualRange
• mapVirtualRangeWithOffset