ng-virtual-list 19.1.19 → 19.1.21

package/lib/const/index.d.ts

@@ -3,6 +3,7 @@ export declare const DEFAULT_ITEM_SIZE = 24;
 export declare const DEFAULT_ITEMS_OFFSET = 2;
 export declare const DEFAULT_LIST_SIZE = 400;
 export declare const DEFAULT_SNAP = false;
+export declare const DEFAULT_ENABLED_BUFFER_OPTIMIZATION = true;
 export declare const DEFAULT_SNAP_TO_ITEM = false;
 export declare const DEFAULT_DYNAMIC_SIZE = false;
 export declare const TRACK_BY_PROPERTY_NAME = "id";

package/lib/models/scroll-event.model.d.ts

@@ -10,13 +10,41 @@ export interface IScrollEvent {
      * Scroll area offset
      */
     scrollSize: number;
+    /**
+     * Full size of the scroll area
+     */
+    scrollWeight: number;
+    /**
+     * Viewport size
+     */
+    size: number;
+    /**
+     * Size of the list of elements
+     */
+    listSize: number;
+    /**
+     * Specifies whether the list orientation is vertical.
+     */
+    isVertical: boolean;
     /**
      * A value of -1 indicates the direction is up or left (if the list direction is horizontal).
      * A value of 1 indicates the direction is down or right (if the list direction is horizontal).
      */
     direction: ScrollDirection;
+    /**
+     * If true then indicates that the list has been scrolled to the end.
+     */
+    isStart: boolean;
     /**
      * If true then indicates that the list has been scrolled to the end.
      */
     isEnd: boolean;
+    /**
+     * Delta of marked and unmarked area
+     */
+    delta: number;
+    /**
+     * Scroll delta
+     */
+    scrollDelta: number;
 }

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

@@ -2,7 +2,7 @@ import { AfterViewInit, ComponentRef, ElementRef, OnDestroy, TemplateRef, ViewCo
 import { Observable } from 'rxjs';
 import { NgVirtualListItemComponent } from './components/ng-virtual-list-item.component';
 import { IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
-import { Id } from './types';
+import { Id, IRect } from './types';
 import { Direction } from './enums';
 import * as i0 from "@angular/core";
 /**
@@ -44,6 +44,12 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
      * Determines whether scroll positions will be snapped to the element. Default value is "false".
      */
     snapToItem: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Enables buffer optimization.
+     * Can only be used if items in the collection are not added or updated. Otherwise, artifacts in the form of twitching of the scroll area are possible.
+     * Works only if the property dynamic = true
+     */
+    enabledBufferOptimization: import("@angular/core").InputSignal<boolean>;
     /**
      * Rendering element template.
      */
@@ -104,6 +110,10 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
      */
     protected tracking(): void;
     private resetBoundsSize;
+    /**
+     * Returns the bounds of an element with a given id
+     */
+    getItemBounds(id: Id): IRect | undefined;
     /**
      * The method scrolls the list to the element with the given id and returns the value of the scrolled area.
      * Behavior accepts the values ​​"auto", "instant" and "smooth".
@@ -113,8 +123,10 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
     private clearScrollToRepeatExecutionTimeout;
     protected scrollToExecutor(id: Id, behavior: ScrollBehavior, iteration?: number): void;
     scrollToEnd(behavior?: ScrollBehavior): void;
+    private _onContainerScrollHandler;
+    private _onContainerScrollEndHandler;
     ngAfterViewInit(): void;
     ngOnDestroy(): 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; }; "snapToItem": { "alias": "snapToItem"; "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; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": { "alias": "items"; "required": true; "isSignal": true; }; "snap": { "alias": "snap"; "required": false; "isSignal": true; }; "snapToItem": { "alias": "snapToItem"; "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; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, true, never>;
 }

package/lib/utils/cacheMap.d.ts

@@ -19,7 +19,7 @@ type CacheMapListeners = OnChangeEventListener;
 export declare class CacheMap<I = string | number, B = any, E = CacheMapEvents, L = CacheMapListeners> extends EventEmitter<E, L> implements ICacheMap {
     protected _map: Map<I, B>;
     protected _version: number;
-    protected _previouseFullHeigh: number;
+    protected _previouseFullSize: number;
     protected _delta: number;
     get delta(): number;
     protected _deltaDirection: ScrollDirection;

package/lib/utils/collection.d.ts

@@ -1,7 +1,18 @@
 import { Id } from "../types";
+interface ICollectionDelta<I extends {
+    id: Id;
+}, C extends Array<I>> {
+    deletedOrUpdated: C;
+    notChanged: C;
+    added: C;
+}
 /**
  * Returns the removed or updated elements of a collection.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/utils/collection.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
  */
 export declare const getCollectionRemovedOrUpdatedItems: <I extends {
     id: Id;
-}, C extends Array<I>>(previousCollection: C | null | undefined, currentCollection: C | null | undefined) => C;
+}, C extends Array<I>>(previousCollection: C | null | undefined, currentCollection: C | null | undefined) => ICollectionDelta<I, C>;
+export {};

package/lib/utils/scrollEvent.d.ts

@@ -1,4 +1,18 @@
 import { IScrollEvent, ScrollDirection } from "../models";
+interface IScrollEventParams {
+    direction: ScrollDirection;
+    container: HTMLElement;
+    list: HTMLElement;
+    delta: number;
+    scrollDelta: number;
+    isVertical: boolean;
+}
+/**
+ * Scroll event.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/utils/scrollEvent.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
 export declare class ScrollEvent implements IScrollEvent {
     private _direction;
     get direction(): ScrollDirection;
@@ -18,5 +32,8 @@ export declare class ScrollEvent implements IScrollEvent {
     get isEnd(): boolean;
     private _delta;
     get delta(): number;
-    constructor(direction: ScrollDirection, container: HTMLElement, list: HTMLElement, delta: number, isVertical: boolean);
+    private _scrollDelta;
+    get scrollDelta(): number;
+    constructor(params: IScrollEventParams);
 }
+export {};

package/lib/utils/trackBox.d.ts

@@ -30,6 +30,7 @@ export interface IMetrics {
     rightItemLength: number;
     rightItemsWeight: number;
     scrollSize: number;
+    sizeOfAddedItems: number;
     sizeProperty: typeof HEIGHT_PROP_NAME | typeof WIDTH_PROP_NAME;
     snap: boolean;
     snippedPos: number;
@@ -68,9 +69,12 @@ export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheM
     set items(v: IRenderVirtualListCollection | null | undefined);
     protected _displayComponents: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined;
     set displayComponents(v: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined);
+    enabledBufferOptimization: boolean;
     constructor(trackingPropertyName: string);
     set(id: Id, bounds: IRect): Map<Id, IRect>;
     private _fireChanges;
+    private _isExistAddedItems;
+    private _addedItemsMap;
     private _previousCollection;
     private _debounceChanges;
     protected fireChange(): void;
@@ -80,6 +84,7 @@ export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheM
     resetCollection<I extends {
         id: Id;
     }, C extends Array<I>>(currentCollection: C | null | undefined): void;
+    private startScrollDeltaCalculationIfNeed;
     /**
      * Clears the cache of items from the list
      */
@@ -122,8 +127,11 @@ export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheM
     protected recalculateMetrics<I extends {
         id: Id;
     }, C extends Array<I>>(options: IRecalculateMetricsOptions<I, C>): IMetrics;
+    protected _scrollDelta: number;
+    get scrollDelta(): number;
     clearDeltaDirection(): void;
     clearDelta(clearDirectionDetector?: boolean): void;
+    protected stopScrollDeltaCalculation(): void;
     protected generateDisplayCollection<I extends {
         id: Id;
     }, C extends Array<I>>(items: C, stickyMap: IVirtualListStickyMap, metrics: IMetrics): IRenderVirtualListCollection;
@@ -135,6 +143,7 @@ export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheM
         [id: number]: number;
     }): void;
     untrackComponentByIdProperty(component?: NgVirtualListItemComponent | undefined): void;
+    getItemBounds(id: Id): IRect | undefined;
     protected cacheElements(): void;
     /**
      * Returns calculated bounds from cache

package/package.json

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