ng-virtual-list 14.3.2 → 14.4.1

package/lib/components/ng-virtual-list-item.component.d.ts

@@ -1,7 +1,7 @@
 import { ChangeDetectorRef, ElementRef, TemplateRef } from '@angular/core';
 import { IRenderVirtualListItem } from '../models/render-item.model';
 import { ISize } from '../types';
-import { BaseVirtualListItemComponent } from '../models';
+import { BaseVirtualListItemComponent } from '../models/base-virtual-list-item-component';
 import * as i0 from "@angular/core";
 /**
  * Virtual list item component
@@ -10,15 +10,15 @@ import * as i0 from "@angular/core";
  * @email djonnyx@gmail.com
  */
 export declare class NgVirtualListItemComponent extends BaseVirtualListItemComponent {
-    protected _cdr: ChangeDetectorRef;
-    protected _elementRef: ElementRef<HTMLElement>;
-    protected static __nextId: number;
-    protected _id: number;
+    private _cdr;
+    private _elementRef;
+    private static __nextId;
+    private _id;
     get id(): number;
     regular: boolean;
     data: IRenderVirtualListItem | undefined;
     set item(v: IRenderVirtualListItem | undefined);
-    protected _regularLength: string;
+    private _regularLength;
     set regularLength(v: string);
     get item(): IRenderVirtualListItem | undefined;
     get itemId(): import("../types").Id | undefined;
@@ -26,7 +26,7 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     set renderer(v: TemplateRef<any> | undefined);
     get element(): HTMLElement;
     constructor(_cdr: ChangeDetectorRef, _elementRef: ElementRef<HTMLElement>);
-    protected update(): void;
+    private update;
     getBounds(): ISize;
     show(): void;
     hide(): void;

package/lib/const/index.d.ts

@@ -1,7 +1,8 @@
 import { SnappingMethods } from "../enums";
 import { Directions } from "../enums/directions";
 export declare const DEFAULT_ITEM_SIZE = 24;
-export declare const DEFAULT_ITEMS_OFFSET = 2;
+export declare const DEFAULT_BUFFER_SIZE = 2;
+export declare const DEFAULT_MAX_BUFFER_SIZE = 100;
 export declare const DEFAULT_LIST_SIZE = 400;
 export declare const DEFAULT_SNAP = false;
 export declare const DEFAULT_ENABLED_BUFFER_OPTIMIZATION = false;

package/lib/models/base-virtual-list-item-component.d.ts

@@ -18,7 +18,6 @@ export declare abstract class BaseVirtualListItemComponent {
     abstract itemRenderer: TemplateRef<any> | undefined;
     abstract set renderer(v: TemplateRef<any> | undefined);
     abstract get element(): HTMLElement;
-    protected abstract update(): void;
     abstract getBounds(): ISize;
     abstract show(): void;
     abstract hide(): void;

package/lib/models/index.d.ts

@@ -3,7 +3,4 @@ import { IScrollEvent } from './scroll-event.model';
 import { IVirtualListItem } from './item.model';
 import { IVirtualListStickyMap } from './sticky-map.model';
 import { IVirtualListCollection } from './collection.model';
-import { BaseVirtualListItemComponent } from './base-virtual-list-item-component';
-import { Component$1 } from './component.model';
-export type { ScrollDirection, IScrollEvent, IVirtualListItem, IVirtualListStickyMap, IVirtualListCollection, Component$1, };
-export { BaseVirtualListItemComponent, };
+export type { ScrollDirection, IScrollEvent, IVirtualListItem, IVirtualListStickyMap, IVirtualListCollection, };

package/lib/ng-virtual-list.component.d.ts

@@ -1,10 +1,8 @@
-import { AfterViewInit, ChangeDetectorRef, ComponentRef, ElementRef, EventEmitter, OnDestroy, OnInit, TemplateRef, ViewContainerRef } from '@angular/core';
-import { BehaviorSubject, Observable } from 'rxjs';
-import { BaseVirtualListItemComponent, Component$1, IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
+import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import { Observable } from 'rxjs';
+import { IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
 import { Id, ISize } from './types';
-import { IRenderVirtualListCollection } from './models/render-collection.model';
 import { Direction, SnappingMethod } from './enums';
-import { TrackBox } from './utils';
 import { DisposableComponent } from './utils/disposableComponent';
 import * as i0 from "@angular/core";
 /**
@@ -16,19 +14,19 @@ import * as i0 from "@angular/core";
  * @email djonnyx@gmail.com
  */
 export declare class NgVirtualListComponent extends DisposableComponent implements AfterViewInit, OnInit, OnDestroy {
-    protected _cdr: ChangeDetectorRef;
-    protected _elementRef: ElementRef<HTMLDivElement>;
-    protected static __nextId: number;
-    protected _id: number;
+    private _cdr;
+    private _elementRef;
+    private static __nextId;
+    private _id;
     /**
      * Readonly. Returns the unique identifier of the component.
      */
     get id(): number;
-    protected _listContainerRef: ViewContainerRef | undefined;
-    protected _container: ElementRef<HTMLDivElement> | undefined;
-    protected _list: ElementRef<HTMLUListElement> | undefined;
-    protected _snapContainerRef: ViewContainerRef | undefined;
-    protected _snappedContainer: ViewContainerRef | undefined;
+    private _listContainerRef;
+    private _container;
+    private _list;
+    private _snapContainerRef;
+    private _snappedContainer;
     /**
      * Fires when the list has been scrolled.
      */
@@ -37,22 +35,22 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      * Fires when the list has completed scrolling.
      */
     onScrollEnd: EventEmitter<IScrollEvent>;
-    protected _$items: BehaviorSubject<IVirtualListCollection<Object> | undefined>;
+    private _$items;
     readonly $items: Observable<IVirtualListCollection<Object> | undefined>;
-    protected _itemsTransform: (v: IVirtualListCollection | undefined) => IVirtualListCollection<Object> | undefined;
+    private _itemsTransform;
     /**
      * Collection of list items.
      */
     set items(v: IVirtualListCollection);
     get items(): IVirtualListCollection;
-    protected _$snap: BehaviorSubject<boolean>;
+    private _$snap;
     readonly $snap: Observable<boolean>;
     /**
      * Determines whether elements will snap. Default value is "true".
      */
     set snap(v: boolean);
     get snap(): boolean;
-    protected _$enabledBufferOptimization: BehaviorSubject<boolean>;
+    private _$enabledBufferOptimization;
     readonly $enabledBufferOptimization: Observable<boolean>;
     /**
      * Experimental!
@@ -62,15 +60,15 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set enabledBufferOptimization(v: boolean);
     get enabledBufferOptimization(): boolean;
-    protected _$itemRenderer: BehaviorSubject<TemplateRef<any> | undefined>;
+    private _$itemRenderer;
     readonly $itemRenderer: Observable<TemplateRef<any> | undefined>;
-    protected _$renderer: BehaviorSubject<TemplateRef<any> | undefined>;
+    private _$renderer;
     /**
     * Rendering element template.
     */
     set itemRenderer(v: TemplateRef<any>);
     get itemRenderer(): TemplateRef<any>;
-    protected _$stickyMap: BehaviorSubject<IVirtualListStickyMap>;
+    private _$stickyMap;
     readonly $stickyMap: Observable<IVirtualListStickyMap>;
     /**
      * Dictionary zIndex by id of the list element. If the value is not set or equal to 0,
@@ -78,8 +76,8 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set stickyMap(v: IVirtualListStickyMap);
     get stickyMap(): IVirtualListStickyMap;
-    protected _itemSizeOptions: (v: number | undefined) => number;
-    protected _$itemSize: BehaviorSubject<number>;
+    private _itemSizeOptions;
+    private _$itemSize;
     readonly $itemSize: Observable<number>;
     /**
      * If direction = 'vertical', then the height of a typical element. If direction = 'horizontal', then the width of a typical element.
@@ -87,7 +85,7 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set itemSize(v: number);
     get itemSize(): number;
-    protected _$dynamicSize: BehaviorSubject<boolean>;
+    private _$dynamicSize;
     readonly $dynamicSize: Observable<boolean>;
     /**
      * If true then the items in the list can have different sizes and the itemSize property is ignored.
@@ -95,29 +93,43 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set dynamicSize(v: boolean);
     get dynamicSize(): boolean;
-    protected _$direction: BehaviorSubject<Direction>;
+    private _$direction;
     readonly $direction: Observable<Direction>;
     /**
      * Determines the direction in which elements are placed. Default value is "vertical".
      */
     set direction(v: Direction);
     get direction(): Direction;
-    protected _$itemsOffset: BehaviorSubject<number>;
-    readonly $itemsOffset: Observable<number>;
     /**
-     * Number of elements outside the scope of visibility. Default value is 2.
+     * @deprecated "itemOffset" parameter is deprecated. Use "bufferSize" and "maxBufferSize".
      */
     set itemsOffset(v: number);
-    get itemsOffset(): number;
-    protected _$trackBy: BehaviorSubject<string>;
+    private _$bufferSize;
+    readonly $bufferSize: Observable<number>;
+    /**
+     * Number of elements outside the scope of visibility. Default value is 2.
+     */
+    set bufferSize(v: number);
+    get bufferSize(): number;
+    private _maxBufferSizeTransform;
+    private _$maxBufferSize;
+    readonly $maxBufferSize: Observable<number>;
+    /**
+     * Maximum number of elements outside the scope of visibility. Default value is 100.
+     * If maxBufferSize is set to be greater than bufferSize, then adaptive buffer mode is enabled.
+     * The greater the scroll size, the more elements are allocated for rendering.
+     */
+    set maxBufferSize(v: number);
+    get maxBufferSize(): number;
+    private _$trackBy;
     readonly $trackBy: Observable<string>;
     /**
      * The name of the property by which tracking is performed
      */
     set trackBy(v: string);
     get trackBy(): string;
-    protected _isVertical: boolean;
-    protected _$snappingMethod: BehaviorSubject<SnappingMethod>;
+    private _isVertical;
+    private _$snappingMethod;
     readonly $snappingMethod: Observable<SnappingMethod>;
     /**
      * Snapping method.
@@ -126,49 +138,48 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set snappingMethod(v: SnappingMethod);
     get snappingMethod(): SnappingMethod;
-    protected _isSnappingMethodAdvanced: boolean;
+    private _isSnappingMethodAdvanced;
     get isSnappingMethodAdvanced(): boolean;
-    protected _displayComponents: Array<ComponentRef<BaseVirtualListItemComponent>>;
-    protected _snapedDisplayComponent: ComponentRef<BaseVirtualListItemComponent> | undefined;
-    protected _$bounds: BehaviorSubject<ISize | null>;
-    protected _$scrollSize: BehaviorSubject<number>;
-    protected _resizeObserver: ResizeObserver | null;
-    protected _resizeSnappedComponentHandler: () => void;
-    protected _resizeSnappedObserver: ResizeObserver | null;
-    protected _onResizeHandler: () => void;
-    protected _onScrollHandler: (e?: Event) => void;
-    protected _$initialized: BehaviorSubject<boolean>;
+    private _displayComponents;
+    private _snapedDisplayComponent;
+    private _$bounds;
+    private _$scrollSize;
+    private _resizeObserver;
+    private _resizeSnappedComponentHandler;
+    private _resizeSnappedObserver;
+    private _onResizeHandler;
+    private _onScrollHandler;
+    private _$initialized;
     readonly $initialized: Observable<boolean>;
     /**
      * Base class of the element component
      */
-    protected _itemComponentClass: Component$1<BaseVirtualListItemComponent>;
+    private _itemComponentClass;
     /**
      * Base class trackBox
      */
-    protected _trackBoxClass: Component$1<TrackBox>;
+    private _trackBoxClass;
     /**
      * Dictionary of element sizes by their id
      */
-    protected _trackBox: TrackBox;
-    protected _onTrackBoxChangeHandler: (v: number) => void;
-    protected _$cacheVersion: BehaviorSubject<number>;
+    private _trackBox;
+    private _onTrackBoxChangeHandler;
+    private _$cacheVersion;
     get $cacheVersion(): Observable<number>;
     constructor(_cdr: ChangeDetectorRef, _elementRef: ElementRef<HTMLDivElement>);
-    protected setupRenderer(): void;
-    protected onInit(): void;
-    protected listenCacheChangesIfNeed(value: boolean): void;
-    protected getIsSnappingMethodAdvanced(m?: SnappingMethod): boolean;
-    protected getIsVertical(d?: Direction): boolean;
-    protected _componentsResizeObserver: ResizeObserver;
-    protected createDisplayComponentsIfNeed(displayItems: IRenderVirtualListCollection | null): void;
-    protected updateRegularRenderer(): void;
-    protected resetRenderers(itemRenderer?: TemplateRef<HTMLElement>): void;
+    private onInit;
+    private listenCacheChangesIfNeed;
+    private getIsSnappingMethodAdvanced;
+    private getIsVertical;
+    private _componentsResizeObserver;
+    private createDisplayComponentsIfNeed;
+    private updateRegularRenderer;
+    private resetRenderers;
     /**
      * Tracking by id
      */
-    protected tracking(): void;
-    protected resetBoundsSize(isVertical: boolean, totalSize: number): void;
+    private tracking;
+    private resetBoundsSize;
     /**
      * Returns the bounds of an element with a given id
      */
@@ -178,17 +189,17 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      * Behavior accepts the values ​​"auto", "instant" and "smooth".
      */
     scrollTo(id: Id, behavior?: ScrollBehavior): void;
-    protected _scrollToRepeatExecutionTimeout: any;
-    protected clearScrollToRepeatExecutionTimeout(): void;
-    protected scrollToExecutor(id: Id, behavior: ScrollBehavior, iteration?: number, isLastIteration?: boolean): void;
+    private _scrollToRepeatExecutionTimeout;
+    private clearScrollToRepeatExecutionTimeout;
+    private scrollToExecutor;
     /**
      * Scrolls the scroll area to the desired element with the specified ID.
      */
     scrollToEnd(behavior?: ScrollBehavior): void;
-    protected _onContainerScrollHandler: (e: Event) => void;
-    protected _onContainerScrollEndHandler: (e: Event) => void;
-    protected afterViewInit(): void;
-    protected dispose(): void;
+    private _onContainerScrollHandler;
+    private _onContainerScrollEndHandler;
+    private afterViewInit;
+    private dispose;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": "items"; "snap": "snap"; "enabledBufferOptimization": "enabledBufferOptimization"; "itemRenderer": "itemRenderer"; "stickyMap": "stickyMap"; "itemSize": "itemSize"; "dynamicSize": "dynamicSize"; "direction": "direction"; "itemsOffset": "itemsOffset"; "trackBy": "trackBy"; "snappingMethod": "snappingMethod"; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, false>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": "items"; "snap": "snap"; "enabledBufferOptimization": "enabledBufferOptimization"; "itemRenderer": "itemRenderer"; "stickyMap": "stickyMap"; "itemSize": "itemSize"; "dynamicSize": "dynamicSize"; "direction": "direction"; "itemsOffset": "itemsOffset"; "bufferSize": "bufferSize"; "maxBufferSize": "maxBufferSize"; "trackBy": "trackBy"; "snappingMethod": "snappingMethod"; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, false>;
 }

package/lib/utils/buffer-interpolation.d.ts

@@ -0,0 +1,5 @@
+export interface IExtraOptions {
+    extremumThreshold?: number;
+    bufferSize?: number;
+}
+export declare const bufferInterpolation: (currentBufferValue: number, array: Array<number>, value: number, extra?: IExtraOptions) => number;

package/lib/utils/index.d.ts

@@ -1,9 +1,6 @@
-import { isDirection } from "./isDirection";
 import { debounce } from "./debounce";
 import { toggleClassName } from './toggleClassName';
-import { Tracker } from "./tracker";
-import { TrackBox, IUpdateCollectionReturns, TRACK_BOX_CHANGE_EVENT_NAME, IMetrics, IRecalculateMetricsOptions, IGetItemPositionOptions, IUpdateCollectionOptions, CacheMapEvents, OnChangeEventListener, CacheMapListeners, ItemDisplayMethods } from "./trackBox";
-import { CMap, ICacheMap, CACHE_BOX_CHANGE_EVENT_NAME } from './cacheMap';
+import { IMetrics } from "./trackBox";
 import { ScrollEvent } from "./scrollEvent";
-export { isDirection, debounce, toggleClassName, ScrollEvent, TrackBox, Tracker, TRACK_BOX_CHANGE_EVENT_NAME, CMap, CACHE_BOX_CHANGE_EVENT_NAME, };
-export type { ICacheMap, IUpdateCollectionReturns, IMetrics, IRecalculateMetricsOptions, IGetItemPositionOptions, IUpdateCollectionOptions, CacheMapEvents, OnChangeEventListener, CacheMapListeners, ItemDisplayMethods, };
+export { debounce, toggleClassName, ScrollEvent, };
+export type { IMetrics, };

package/lib/utils/trackBox.d.ts

@@ -5,7 +5,8 @@ import { CacheMap, CMap } from "./cacheMap";
 import { Tracker } from "./tracker";
 import { ISize } from "../types";
 import { HEIGHT_PROP_NAME, WIDTH_PROP_NAME } from "../const";
-import { BaseVirtualListItemComponent, IVirtualListStickyMap } from "../models";
+import { IVirtualListStickyMap } from "../models";
+import { BaseVirtualListItemComponent } from "../models/base-virtual-list-item-component";
 export declare const TRACK_BOX_CHANGE_EVENT_NAME = "change";
 export interface IMetrics {
     delta: number;
@@ -46,7 +47,8 @@ export interface IRecalculateMetricsOptions<I extends {
     collection: C;
     isVertical: boolean;
     itemSize: number;
-    itemsOffset: number;
+    bufferSize: number;
+    maxBufferSize: number;
     dynamicSize: boolean;
     scrollSize: number;
     snap: boolean;
@@ -103,7 +105,9 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
      * Set the trackBy property
      */
     set trackingPropertyName(v: string);
+    protected _trackingPropertyName: string;
     constructor(trackingPropertyName: string);
+    protected initialize(): void;
     set(id: Id, bounds: ISize): CMap<Id, ISize>;
     protected _previousCollection: Array<{
         id: Id;
@@ -117,6 +121,16 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
     protected _previousTotalSize: number;
     protected _scrollDelta: number;
     get scrollDelta(): number;
+    isAdaptiveBuffer: boolean;
+    protected _bufferSequenceExtraThreshold: number;
+    protected _maxBufferSequenceLength: number;
+    protected _bufferSizeSequence: Array<number>;
+    protected _bufferSize: number;
+    get bufferSize(): number;
+    protected _defaultBufferSize: number;
+    protected _maxBufferSize: number;
+    protected _resetBufferSizeTimeout: number;
+    protected _resetBufferSizeTimer: number | undefined;
     protected lifeCircle(): void;
     /**
      * Scans the collection for deleted items and flushes the deleted item cache.
@@ -148,6 +162,10 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
     getNearestItem<I extends {
         id: Id;
     }, C extends Array<I>>(scrollSize: number, items: C, itemSize: number, isVertical: boolean): I | undefined;
+    protected _previousScrollSize: number;
+    protected updateAdaptiveBufferParams(metrics: IMetrics, totalItemsLength: number): void;
+    protected startResetBufferSizeTimer(): void;
+    protected disposeClearBufferSizeTimer(): void;
     /**
      * Calculates the position of an element based on the given scrollSize
      */

package/lib/utils/tracker.d.ts

@@ -1,6 +1,8 @@
 import { ComponentRef } from "@angular/core";
-import { BaseVirtualListItemComponent, ScrollDirection } from "../models";
+import { ScrollDirection } from "../models";
 import { Id, ISize } from "../types";
+import { BaseVirtualListItemComponent } from "../models/base-virtual-list-item-component";
+declare type TrackingPropertyId = string | number;
 export interface IVirtualListItemComponent<I = any> {
     getBounds(): ISize;
     itemId: Id;
@@ -19,7 +21,9 @@ export declare class Tracker<C extends BaseVirtualListItemComponent = any> {
     /**
      * display objects dictionary of indexes by id
      */
-    private _displayObjectIndexMapById;
+    protected _displayObjectIndexMapById: {
+        [id: number]: number;
+    };
     set displayObjectIndexMapById(v: {
         [id: number]: number;
     });
@@ -29,12 +33,14 @@ export declare class Tracker<C extends BaseVirtualListItemComponent = any> {
     /**
      * Dictionary displayItems propertyNameId by items propertyNameId
      */
-    private _trackMap;
+    protected _trackMap: {
+        [id: TrackingPropertyId]: number;
+    } | null;
     get trackMap(): {
         [id: string]: number;
         [id: number]: number;
     } | null;
-    private _trackingPropertyName;
+    protected _trackingPropertyName: string;
     set trackingPropertyName(v: string);
     constructor(trackingPropertyName: string);
     /**
@@ -44,3 +50,4 @@ export declare class Tracker<C extends BaseVirtualListItemComponent = any> {
     untrackComponentByIdProperty(component?: C): void;
     dispose(): void;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-virtual-list",
-  "version": "14.3.2",
+  "version": "14.4.1",
   "author": {
     "name": "Evgenii Grebennikov",
     "email": "djonnyx@gmail.com"