ng-virtual-list 17.0.0 → 17.0.2

package/lib/models/render-item.model.d.ts

@@ -4,7 +4,7 @@ import { IVirtualListItem } from "./item.model";
 import { IRenderVirtualListItemConfig } from "./render-item-config.model";
 /**
  * List screen element model
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/models/render-item.model.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/render-item.model.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

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

@@ -0,0 +1,5 @@
+/**
+ * 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).
+ */
+export type ScrollDirection = -1 | 1;

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

@@ -0,0 +1,18 @@
+import { ScrollDirection } from "./scroll-direction.model";
+/**
+ * Interface IScrollEvent.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/scroll-event.model.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IScrollEvent {
+    /**
+     * Scroll area offset
+     */
+    scrollSize: number;
+    /**
+     * 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;
+}

package/lib/models/sticky-map.model.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/models/sticky-map.model.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/sticky-map.model.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

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

@@ -1,7 +1,7 @@
 import { AfterViewInit, ComponentRef, ElementRef, OnDestroy, TemplateRef, ViewContainerRef, WritableSignal } from '@angular/core';
 import { Observable } from 'rxjs';
 import { NgVirtualListItemComponent } from './components/ng-virtual-list-item.component';
-import { IVirtualListCollection, IVirtualListStickyMap } from './models';
+import { IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
 import { Id } from './types';
 import { Direction } from './enums';
 import * as i0 from "@angular/core";
@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
  * Virtual list component.
  * Maximum performance for extremely large lists.
  * It is based on algorithms for virtualization of screen objects.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/ng-virtual-list.component.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/ng-virtual-list.component.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
@@ -26,11 +26,11 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
     /**
      * Fires when the list has been scrolled.
      */
-    onScroll: import("@angular/core").OutputEmitterRef<number>;
+    onScroll: import("@angular/core").OutputEmitterRef<IScrollEvent>;
     /**
      * Fires when the list has completed scrolling.
      */
-    onScrollEnd: import("@angular/core").OutputEmitterRef<number>;
+    onScrollEnd: import("@angular/core").OutputEmitterRef<IScrollEvent>;
     /**
      * Collection of list items.
      */
@@ -71,18 +71,12 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
      * Number of elements outside the scope of visibility. Default value is 2.
      */
     itemsOffset: import("@angular/core").InputSignal<number>;
-    private _scrollToTimeout;
     private _isVertical;
     protected _displayComponents: Array<ComponentRef<NgVirtualListItemComponent>>;
     protected _bounds: WritableSignal<DOMRect | null>;
     protected _scrollSize: WritableSignal<number>;
     private _resizeObserver;
-    /**
-     * only dynamic
-     */
-    private _scrolledItemId;
     private _onResizeHandler;
-    private _scrollDirection;
     private _onScrollHandler;
     private scrollImmediately;
     private _scrollImmediatelyHandler;
@@ -114,6 +108,9 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnDestroy
      * Behavior accepts the values ​​"auto", "instant" and "smooth".
      */
     scrollTo(id: Id, behavior?: ScrollBehavior): void;
+    private _scrollToRepeatExecutionTimeout;
+    private clearScrollToRepeatExecutionTimeout;
+    protected scrollToExecutor(id: Id, behavior: ScrollBehavior, iteration?: number): void;
     scrollToEnd(behavior?: ScrollBehavior): void;
     ngAfterViewInit(): void;
     ngOnDestroy(): void;

package/lib/types/id.d.ts

@@ -1,6 +1,6 @@
 /**
  * Identifier type
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/types/id.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/types/rect.d.ts

@@ -1,7 +1,7 @@
 import { ISize } from "./size";
 /**
  * Rectangular area interface
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/types/rect.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/rect.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/types/size.d.ts

@@ -1,6 +1,6 @@
 /**
  * Area area Interface
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/types/size.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/size.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/utils/cacheMap.d.ts

@@ -1,3 +1,4 @@
+import { ScrollDirection } from "../models";
 import { EventEmitter } from "./eventEmitter";
 export interface ICacheMap<I = any, B = any> {
     set: (id: I, bounds: B) => Map<I, B>;
@@ -11,7 +12,7 @@ type CacheMapListeners = OnChangeEventListener;
 /**
  * Cache map.
  * Emits a change event on each mutation.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/cacheMap.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/cacheMap.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
@@ -21,8 +22,17 @@ export declare class CacheMap<I = string | number, B = any, E = CacheMapEvents,
     protected _previouseFullHeigh: number;
     protected _delta: number;
     get delta(): number;
+    protected _deltaDirection: ScrollDirection;
+    set deltaDirection(v: ScrollDirection);
+    get deltaDirection(): ScrollDirection;
+    private _scrollDirectionCache;
+    private _scrollDirection;
+    get scrollDirection(): ScrollDirection;
     get version(): number;
+    private _clearScrollDirectionDebounce;
     constructor();
+    clearScrollDirectionCache(): void;
+    private calcScrollDirection;
     protected bumpVersion(): void;
     protected fireChange(): void;
     set(id: I, bounds: B): Map<I, B>;

package/lib/utils/debounce.d.ts

@@ -1,6 +1,6 @@
 /**
  * Simple debounce function.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/debounce.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/debounce.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/utils/eventEmitter.d.ts

@@ -1,7 +1,7 @@
 export type TEventHandler = (...args: Array<any>) => void;
 /**
  * Simple event emitter
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/eventEmitter.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/eventEmitter.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/utils/isDirection.d.ts

@@ -1,7 +1,7 @@
 import { Direction } from "../enums";
 /**
  * Determines the axis membership of a virtual list
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/isDirection.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/isDirection.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/utils/toggleClassName.d.ts

@@ -1,6 +1,6 @@
 /**
  * Switch css classes
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/utils/toggleClassName.ts
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/toggleClassName.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/lib/utils/trackBox.d.ts

@@ -40,7 +40,6 @@ export interface IMetrics {
     totalSize: number;
     typicalItemSize: number;
 }
-export type ScrollDirection = -1 | 0 | 1;
 export interface IRecalculateMetricsOptions<I extends {
     id: Id;
 }, C extends Array<I>> {
@@ -53,14 +52,13 @@ export interface IRecalculateMetricsOptions<I extends {
     scrollSize: number;
     snap: boolean;
     fromItemId?: Id;
-    scrollDirection?: ScrollDirection;
 }
 type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
 type OnChangeEventListener = (version: number) => void;
 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
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/trackBox.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
@@ -85,13 +83,15 @@ export declare class TrackBox extends CacheMap<Id, IRect, CacheMapEvents, CacheM
         totalSize: number;
         delta: number;
     };
+    private getElementNumToEnd;
     /**
      * Calculates list metrics
      */
     protected recalculateMetrics<I extends {
         id: Id;
     }, C extends Array<I>>(options: IRecalculateMetricsOptions<I, C>): IMetrics;
-    clearDelta(): void;
+    clearDeltaDirection(): void;
+    clearDelta(clearDirectionDetector?: boolean): void;
     protected generateDisplayCollection<I extends {
         id: Id;
     }, C extends Array<I>>(items: C, stickyMap: IVirtualListStickyMap, metrics: IMetrics): IRenderVirtualListCollection;

package/lib/utils/tracker.d.ts

@@ -1,7 +1,7 @@
 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
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/tracker.ts
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */

package/package.json

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