ng-virtual-list 17.3.2 → 17.4.1

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

@@ -1,7 +1,7 @@
-import { ChangeDetectorRef, ElementRef, TemplateRef } from '@angular/core';
+import { 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,24 +10,24 @@ import * as i0 from "@angular/core";
  * @email djonnyx@gmail.com
  */
 export declare class NgVirtualListItemComponent extends BaseVirtualListItemComponent {
-    protected static __nextId: number;
-    protected _id: number;
+    private static __nextId;
+    private _id;
     get id(): number;
-    protected _cdr: ChangeDetectorRef;
+    private _cdr;
     regular: boolean;
     data: import("@angular/core").WritableSignal<IRenderVirtualListItem | undefined>;
-    protected _data: IRenderVirtualListItem | undefined;
+    private _data;
     set item(v: IRenderVirtualListItem | undefined);
-    protected _regularLength: string;
+    private _regularLength;
     set regularLength(v: string);
     get item(): IRenderVirtualListItem | undefined;
     get itemId(): import("../types").Id | undefined;
     itemRenderer: import("@angular/core").WritableSignal<TemplateRef<any> | undefined>;
     set renderer(v: TemplateRef<any> | undefined);
-    protected _elementRef: ElementRef<HTMLElement>;
+    private _elementRef;
     get element(): HTMLElement;
     constructor();
-    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: WritableSignal<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, ComponentRef, ElementRef, OnDestroy, OnInit, TemplateRef, ViewContainerRef, WritableSignal } from '@angular/core';
+import { AfterViewInit, OnDestroy, OnInit, TemplateRef } from '@angular/core';
 import { Observable } from 'rxjs';
-import { BaseVirtualListItemComponent, Component$1, IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
+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 * as i0 from "@angular/core";
 /**
  * Virtual list component.
@@ -15,17 +13,17 @@ import * as i0 from "@angular/core";
  * @email djonnyx@gmail.com
  */
 export declare class NgVirtualListComponent implements AfterViewInit, OnInit, OnDestroy {
-    protected static __nextId: number;
-    protected _id: number;
+    private static __nextId;
+    private _id;
     /**
      * Readonly. Returns the unique identifier of the component.
      */
     get id(): number;
-    protected _listContainerRef: ViewContainerRef | undefined;
-    protected _snapContainerRef: ViewContainerRef | undefined;
-    protected _snappedContainer: import("@angular/core").Signal<ElementRef<HTMLDivElement> | undefined>;
-    protected _container: import("@angular/core").Signal<ElementRef<HTMLDivElement> | undefined>;
-    protected _list: import("@angular/core").Signal<ElementRef<HTMLUListElement> | undefined>;
+    private _listContainerRef;
+    private _snapContainerRef;
+    private _snappedContainer;
+    private _container;
+    private _list;
     /**
      * Fires when the list has been scrolled.
      */
@@ -34,7 +32,7 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Fires when the list has completed scrolling.
      */
     onScrollEnd: import("@angular/core").OutputEmitterRef<IScrollEvent>;
-    protected _itemsOptions: any;
+    private _itemsOptions;
     /**
      * Collection of list items.
      */
@@ -54,13 +52,13 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Rendering element template.
      */
     itemRenderer: import("@angular/core").InputSignal<TemplateRef<any>>;
-    protected _itemRenderer: WritableSignal<TemplateRef<any> | undefined>;
+    private _itemRenderer;
     /**
      * Dictionary zIndex by id of the list element. If the value is not set or equal to 0,
      * then a simple element is displayed, if the value is greater than 0, then the sticky position mode is enabled for the element.
      */
     stickyMap: import("@angular/core").InputSignal<IVirtualListStickyMap>;
-    protected _itemSizeOptions: any;
+    private _itemSizeOptions;
     /**
      * If direction = 'vertical', then the height of a typical element. If direction = 'horizontal', then the width of a typical element.
      * Ignored if the dynamicSize property is true.
@@ -75,31 +73,44 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Determines the direction in which elements are placed. Default value is "vertical".
      */
     direction: import("@angular/core").InputSignal<Direction>;
+    private _itemOffsetTransform;
     /**
      * Number of elements outside the scope of visibility. Default value is 2.
+     * @deprecated "itemOffset" parameter is deprecated. Use "bufferSize" and "maxBufferSize".
      */
     itemsOffset: import("@angular/core").InputSignal<number>;
+    /**
+     * Number of elements outside the scope of visibility. Default value is 2.
+     */
+    bufferSize: import("@angular/core").InputSignal<number>;
+    private _maxBufferSizeTransform;
+    /**
+     * 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.
+     */
+    maxBufferSize: import("@angular/core").InputSignal<number>;
     /**
      * Snapping method.
      * 'default' - Normal group rendering.
      * 'advanced' - The group is rendered on a transparent background. List items below the group are not rendered.
      */
     snappingMethod: import("@angular/core").InputSignal<SnappingMethod>;
-    protected _isSnappingMethodAdvanced: boolean;
+    private _isSnappingMethodAdvanced;
     get isSnappingMethodAdvanced(): boolean;
-    protected _isVertical: boolean;
-    protected _displayComponents: Array<ComponentRef<BaseVirtualListItemComponent>>;
-    protected _snapedDisplayComponent: ComponentRef<BaseVirtualListItemComponent> | undefined;
-    protected _bounds: WritableSignal<ISize | null>;
-    protected _scrollSize: WritableSignal<number>;
-    protected _resizeObserver: ResizeObserver | null;
-    protected _resizeSnappedComponentHandler: () => void;
-    protected _resizeSnappedObserver: ResizeObserver | null;
-    protected _componentsResizeObserver: ResizeObserver;
-    protected _onResizeHandler: () => void;
-    protected _onScrollHandler: (e?: Event) => void;
-    protected _elementRef: ElementRef<any>;
-    protected _initialized: WritableSignal<boolean>;
+    private _isVertical;
+    private _displayComponents;
+    private _snapedDisplayComponent;
+    private _bounds;
+    private _scrollSize;
+    private _resizeObserver;
+    private _resizeSnappedComponentHandler;
+    private _resizeSnappedObserver;
+    private _componentsResizeObserver;
+    private _onResizeHandler;
+    private _onScrollHandler;
+    private _elementRef;
+    private _initialized;
     readonly $initialized: Observable<boolean>;
     /**
      * The name of the property by which tracking is performed
@@ -108,31 +119,30 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     /**
      * 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: WritableSignal<number>;
+    private _trackBox;
+    private _onTrackBoxChangeHandler;
+    private _cacheVersion;
     constructor();
-    protected setupRenderer(): void;
-    protected onInit(): void;
-    protected listenCacheChangesIfNeed(value: boolean): void;
-    protected getIsSnappingMethodAdvanced(m?: SnappingMethod): boolean;
-    protected getIsVertical(d?: Direction): boolean;
-    protected createDisplayComponentsIfNeed(displayItems: IRenderVirtualListCollection | null): void;
-    protected updateRegularRenderer(): void;
-    protected resetRenderers(itemRenderer?: TemplateRef<HTMLElement>): void;
+    private onInit;
+    private listenCacheChangesIfNeed;
+    private getIsSnappingMethodAdvanced;
+    private getIsVertical;
+    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
      */
@@ -142,17 +152,17 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Behavior accepts the values ​​"auto", "instant" and "smooth".
      */
     scrollTo(id: Id, behavior?: ScrollBehavior): void;
-    protected _scrollToRepeatExecutionTimeout: number | undefined;
-    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": { "alias": "items"; "required": true; "isSignal": true; }; "snap": { "alias": "snap"; "required": false; "isSignal": true; }; "enabledBufferOptimization": { "alias": "enabledBufferOptimization"; "required": false; "isSignal": true; }; "itemRenderer": { "alias": "itemRenderer"; "required": true; "isSignal": true; }; "stickyMap": { "alias": "stickyMap"; "required": false; "isSignal": true; }; "itemSize": { "alias": "itemSize"; "required": false; "isSignal": true; }; "dynamicSize": { "alias": "dynamicSize"; "required": false; "isSignal": true; }; "direction": { "alias": "direction"; "required": false; "isSignal": true; }; "itemsOffset": { "alias": "itemsOffset"; "required": false; "isSignal": true; }; "snappingMethod": { "alias": "snappingMethod"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": { "alias": "items"; "required": true; "isSignal": true; }; "snap": { "alias": "snap"; "required": false; "isSignal": true; }; "enabledBufferOptimization": { "alias": "enabledBufferOptimization"; "required": false; "isSignal": true; }; "itemRenderer": { "alias": "itemRenderer"; "required": true; "isSignal": true; }; "stickyMap": { "alias": "stickyMap"; "required": false; "isSignal": true; }; "itemSize": { "alias": "itemSize"; "required": false; "isSignal": true; }; "dynamicSize": { "alias": "dynamicSize"; "required": false; "isSignal": true; }; "direction": { "alias": "direction"; "required": false; "isSignal": true; }; "itemsOffset": { "alias": "itemsOffset"; "required": false; "isSignal": true; }; "bufferSize": { "alias": "bufferSize"; "required": false; "isSignal": true; }; "maxBufferSize": { "alias": "maxBufferSize"; "required": false; "isSignal": true; }; "snappingMethod": { "alias": "snappingMethod"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, false, never>;
 }

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";
+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": "17.3.2",
+  "version": "17.4.1",
   "author": {
     "name": "Evgenii Grebennikov",
     "email": "djonnyx@gmail.com"

package/public-api.d.ts

@@ -4,3 +4,4 @@ export * from './lib/ng-virtual-list.component';
 export * from './lib/enums';
 export * from './lib/models';
 export * from './lib/types';
+export * from './lib/utils';