ng-virtual-list 0.7.2 → 14.0.0

package/lib/utils/trackBox.d.ts

@@ -1,73 +1,113 @@
-import { ComponentRef } from "@angular/core";
-import { NgVirtualListItemComponent } from "../components/ng-virtual-list-item.component";
-import { IVirtualListCollection } from "../models/collection.model";
-import { IRenderVirtualListCollection } from "../models/render-collection.model";
-import { IRenderVirtualListItem } from "../models/render-item.model";
-import { Id } from "../types/id";
-import { IRect } from "../types/rect";
-import { CacheMap } from "./cacheMap";
-import { Tracker } from "./tracker";
-import { ISize } from "../types";
-export declare const TRACK_BOX_CHANGE_EVENT_NAME = "change";
-export interface IMetrics {
-    itemsFromStartToScrollEnd: number;
-    itemsFromStartToDisplayEnd: number;
-    itemsOnDisplay: number;
-    itemsOnDisplayLength: number;
-    leftHiddenItemsWeight: number;
-    leftItemLength: number;
-    leftItemsWeight: number;
-    rightItemLength: number;
-    rightItemsWeight: number;
-    snippedPos: number;
-    totalItemsToDisplayEndWeight: number;
-    totalSize: number;
-    typicalItemSize: number;
-}
-interface IRecalculateMetricsOptions {
-    bounds: ISize;
-    collection: IVirtualListCollection;
-    isVertical: boolean;
-    itemSize: number;
-    itemsOffset: number;
-    dynamicSize: boolean;
-    scrollSize: number;
-    snap: boolean;
-}
-type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
-type OnChangeEventListener = (version: number) => void;
-type CacheMapListeners = OnChangeEventListener;
-/**
- * An object that performs tracking, calculations and caching.
- * @homepage https://github.com/DjonnyX/ng-virtual-list/tree/main/projects/ng-virtual-list
- * @author Evgenii Grebennikov
- * @email djonnyx@gmail.com
- */
-export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheMapListeners> {
-    protected _tracker: Tracker<IRenderVirtualListItem, NgVirtualListItemComponent>;
-    protected _items: IRenderVirtualListCollection | null | undefined;
-    set items(v: IRenderVirtualListCollection | null | undefined);
-    protected _displayComponents: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined;
-    set displayComponents(v: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined);
-    constructor(trackingPropertyName: string);
-    set(id: Id, bounds: IRect): Map<Id, IRect>;
-    private _fireChanges;
-    private _debounceChanges;
-    protected fireChange(): void;
-    recalculateMetrics(options: IRecalculateMetricsOptions): IMetrics;
-    /**
-     * tracking by propName
-     */
-    track(): void;
-    setDisplayObjectIndexMapById(v: {
-        [id: number]: number;
-    }): void;
-    untrackComponentByIdProperty(component?: NgVirtualListItemComponent | undefined): void;
-    cacheElements(): void;
-    /**
-     * Returns calculated bounds from cache
-     */
-    private getBoundsFromCache;
-    dispose(): void;
-}
-export {};
+import { ComponentRef } from "@angular/core";
+import { NgVirtualListItemComponent } from "../components/ng-virtual-list-item.component";
+import { IRenderVirtualListCollection } from "../models/render-collection.model";
+import { IRenderVirtualListItem } from "../models/render-item.model";
+import { Id } from "../types/id";
+import { IRect } from "../types/rect";
+import { CacheMap } from "./cacheMap";
+import { Tracker } from "./tracker";
+import { ISize } from "../types";
+import { HEIGHT_PROP_NAME, WIDTH_PROP_NAME } from "../const";
+import { IVirtualListStickyMap } from "../models";
+export declare const TRACK_BOX_CHANGE_EVENT_NAME = "change";
+export interface IMetrics {
+    delta: number;
+    normalizedItemWidth: number;
+    normalizedItemHeight: number;
+    width: number;
+    height: number;
+    dynamicSize: boolean;
+    itemSize: number;
+    itemsFromStartToScrollEnd: number;
+    itemsFromStartToDisplayEnd: number;
+    itemsOnDisplay: number;
+    itemsOnDisplayLength: number;
+    isVertical: boolean;
+    leftHiddenItemsWeight: number;
+    leftItemLength: number;
+    leftItemsWeight: number;
+    renderItems: number;
+    rightItemLength: number;
+    rightItemsWeight: number;
+    scrollSize: number;
+    sizeProperty: typeof HEIGHT_PROP_NAME | typeof WIDTH_PROP_NAME;
+    snap: boolean;
+    snippedPos: number;
+    startIndex: number;
+    startPosition: number;
+    totalItemsToDisplayEndWeight: number;
+    totalLength: number;
+    totalSize: number;
+    typicalItemSize: number;
+}
+export declare type ScrollDirection = -1 | 0 | 1;
+export interface IRecalculateMetricsOptions<I extends {
+    id: Id;
+}, C extends Array<I>> {
+    bounds: ISize;
+    collection: C;
+    isVertical: boolean;
+    itemSize: number;
+    itemsOffset: number;
+    dynamicSize: boolean;
+    scrollSize: number;
+    snap: boolean;
+    fromItemId?: Id;
+    scrollDirection?: ScrollDirection;
+}
+declare type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
+declare type OnChangeEventListener = (version: number) => void;
+declare type CacheMapListeners = OnChangeEventListener;
+/**
+ * An object that performs tracking, calculations and caching.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/trackBox.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheMapListeners> {
+    protected _tracker: Tracker<IRenderVirtualListItem, NgVirtualListItemComponent>;
+    protected _items: IRenderVirtualListCollection | null | undefined;
+    set items(v: IRenderVirtualListCollection | null | undefined);
+    protected _displayComponents: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined;
+    set displayComponents(v: Array<ComponentRef<NgVirtualListItemComponent>> | null | undefined);
+    constructor(trackingPropertyName: string);
+    set(id: Id, bounds: IRect): Map<Id, IRect>;
+    private _fireChanges;
+    private _debounceChanges;
+    protected fireChange(): void;
+    getItemPosition<I extends {
+        id: Id;
+    }, C extends Array<I>>(id: Id, stickyMap: IVirtualListStickyMap, options: IRecalculateMetricsOptions<I, C>): number;
+    updateCollection<I extends {
+        id: Id;
+    }, C extends Array<I>>(items: C, stickyMap: IVirtualListStickyMap, options: Omit<IRecalculateMetricsOptions<I, C>, 'collection'>): {
+        displayItems: IRenderVirtualListCollection;
+        totalSize: number;
+        delta: number;
+    };
+    /**
+     * Calculates list metrics
+     */
+    protected recalculateMetrics<I extends {
+        id: Id;
+    }, C extends Array<I>>(options: IRecalculateMetricsOptions<I, C>): IMetrics;
+    clearDelta(): void;
+    protected generateDisplayCollection<I extends {
+        id: Id;
+    }, C extends Array<I>>(items: C, stickyMap: IVirtualListStickyMap, metrics: IMetrics): IRenderVirtualListCollection;
+    /**
+     * tracking by propName
+     */
+    track(): void;
+    setDisplayObjectIndexMapById(v: {
+        [id: number]: number;
+    }): void;
+    untrackComponentByIdProperty(component?: NgVirtualListItemComponent | undefined): void;
+    protected cacheElements(): void;
+    /**
+     * Returns calculated bounds from cache
+     */
+    private getBoundsFromCache;
+    dispose(): void;
+}
+export {};

package/lib/utils/tracker.d.ts

@@ -1,38 +1,38 @@
-import { ComponentRef } from "@angular/core";
-/**
- * Tracks display items by property
- * @homepage https://github.com/DjonnyX/ng-virtual-list/tree/main/projects/ng-virtual-list
- * @author Evgenii Grebennikov
- * @email djonnyx@gmail.com
- */
-export declare class Tracker<I = any, C = {
-    [prop: string]: any;
-}> {
-    /**
-     * display objects dictionary of indexes by id
-     */
-    private _displayObjectIndexMapById;
-    set displayObjectIndexMapById(v: {
-        [id: number]: number;
-    });
-    get displayObjectIndexMapById(): {
-        [id: number]: number;
-    };
-    /**
-     * Dictionary displayItems propertyNameId by items propertyNameId
-     */
-    private _trackMap;
-    get trackMap(): {
-        [id: string]: number;
-        [id: number]: number;
-    } | null;
-    private _trackingPropertyName;
-    constructor(trackingPropertyName: string);
-    /**
-     * tracking by propName
-     */
-    track(items: Array<any>, components: Array<ComponentRef<any>>, afterComponentSetup?: (component: C, item: I) => void): void;
-    untrackComponentByIdProperty(component?: C): void;
-    private _checkComponentProperty;
-    dispose(): void;
-}
+import { ComponentRef } from "@angular/core";
+/**
+ * Tracks display items by property
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/tracker.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare class Tracker<I = any, C = {
+    [prop: string]: any;
+}> {
+    /**
+     * display objects dictionary of indexes by id
+     */
+    private _displayObjectIndexMapById;
+    set displayObjectIndexMapById(v: {
+        [id: number]: number;
+    });
+    get displayObjectIndexMapById(): {
+        [id: number]: number;
+    };
+    /**
+     * Dictionary displayItems propertyNameId by items propertyNameId
+     */
+    private _trackMap;
+    get trackMap(): {
+        [id: string]: number;
+        [id: number]: number;
+    } | null;
+    private _trackingPropertyName;
+    constructor(trackingPropertyName: string);
+    /**
+     * tracking by propName
+     */
+    track(items: Array<any>, components: Array<ComponentRef<any>>, afterComponentSetup?: (component: C, item: I) => void): void;
+    untrackComponentByIdProperty(component?: C): void;
+    private _checkComponentProperty;
+    dispose(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-virtual-list",
-  "version": "0.7.2",
+  "version": "14.0.0",
   "author": {
     "name": "Evgenii Grebennikov",
     "email": "djonnyx@gmail.com"
@@ -13,17 +13,25 @@
     "virtual",
     "virtualized",
     "list",
-    "scroll"
+    "group",
+    "grouped",
+    "scroll",
+    "scrolling",
+    "scroller"
   ],
   "peerDependencies": {
-    "@angular/common": "^19.2.0",
-    "@angular/core": "^19.2.0"
+    "@angular/common": "^14.2.0",
+    "@angular/core": "^14.2.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "sideEffects": false,
-  "module": "fesm2022/ng-virtual-list.mjs",
+  "module": "fesm2015/ng-virtual-list.mjs",
+  "es2020": "fesm2020/ng-virtual-list.mjs",
+  "esm2020": "esm2020/ng-virtual-list.mjs",
+  "fesm2020": "fesm2020/ng-virtual-list.mjs",
+  "fesm2015": "fesm2015/ng-virtual-list.mjs",
   "typings": "index.d.ts",
   "exports": {
     "./package.json": {
@@ -31,7 +39,11 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "default": "./fesm2022/ng-virtual-list.mjs"
+      "esm2020": "./esm2020/ng-virtual-list.mjs",
+      "es2020": "./fesm2020/ng-virtual-list.mjs",
+      "es2015": "./fesm2015/ng-virtual-list.mjs",
+      "node": "./fesm2015/ng-virtual-list.mjs",
+      "default": "./fesm2020/ng-virtual-list.mjs"
     }
   }
 }

package/public-api.d.ts

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