ng-virtual-list 18.3.2 → 18.4.0

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/ng-virtual-list.component.d.ts

@@ -75,10 +75,23 @@ 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.
@@ -154,5 +167,5 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     protected afterViewInit(): void;
     protected dispose(): void;
     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/trackBox.d.ts

@@ -46,7 +46,8 @@ export interface IRecalculateMetricsOptions<I extends {
     collection: C;
     isVertical: boolean;
     itemSize: number;
-    itemsOffset: number;
+    bufferSize: number;
+    maxBufferSize: number;
     dynamicSize: boolean;
     scrollSize: number;
     snap: boolean;
@@ -117,6 +118,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 +159,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/package.json

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