ng-virtual-list 17.7.13 → 17.7.15

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

@@ -1,34 +1,10 @@
 import { TemplateRef } from '@angular/core';
 import { IRenderVirtualListItem } from '../models/render-item.model';
-import { Id, IRect, ISize } from '../types';
+import { Id, ISize } from '../types';
 import { BaseVirtualListItemComponent } from '../models/base-virtual-list-item-component';
 import { NgVirtualListService } from '../ng-virtual-list.service';
-import { IRenderVirtualListItemConfig } from '../models/render-item-config.model';
+import { IDisplayObjectConfig, IDisplayObjectMeasures } from '../models';
 import * as i0 from "@angular/core";
-interface IItemConfig extends IRenderVirtualListItemConfig {
-    /**
-     * Determines whether the element has focus or not.
-     */
-    focus: boolean;
-    /**
-     * Determines whether the element is selected or not.
-     */
-    selected: boolean;
-    /**
-     * Determines whether the element is collapsed or not.
-     */
-    collapsed: boolean;
-    /**
-      * Selects a list item
-      * @param selected - If the value is undefined, then the toggle method is executed, if false or true, then the selection/deselection is performed.
-      */
-    select: (selected: boolean | undefined) => void;
-    /**
-      * Collapse list items
-      * @param collapsed - If the value is undefined, then the toggle method is executed, if false or true, then the collapse/expand is performed.
-      */
-    collapse: (collapsed: boolean | undefined) => void;
-}
 /**
  * Virtual list item component
  * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/components/ng-virtual-list-item.component.ts
@@ -42,14 +18,9 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     protected _service: NgVirtualListService;
     private _isSelected;
     private _isCollapsed;
-    config: import("@angular/core").WritableSignal<IItemConfig>;
-    measures: import("@angular/core").WritableSignal<(IRect & {
-        /**
-         * Delta is calculated for Snapping Method.ADVANCED
-         */
-        delta: number;
-    }) | undefined>;
-    focus: import("@angular/core").WritableSignal<boolean>;
+    config: import("@angular/core").WritableSignal<IDisplayObjectConfig>;
+    measures: import("@angular/core").WritableSignal<IDisplayObjectMeasures | undefined>;
+    focused: import("@angular/core").WritableSignal<boolean>;
     part: import("@angular/core").WritableSignal<string>;
     regular: boolean;
     data: import("@angular/core").WritableSignal<IRenderVirtualListItem<any> | undefined>;
@@ -65,9 +36,11 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     get element(): HTMLElement;
     private _selectHandler;
     private _collapseHandler;
+    private _focusHandler;
     constructor();
     private focusNext;
     private focusPrev;
+    private focus;
     private updateMeasures;
     private updateConfig;
     private update;
@@ -79,4 +52,3 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListItemComponent, "ng-virtual-list-item", never, {}, {}, never, never, false, never>;
 }
-export {};

package/lib/const/index.d.ts

@@ -1,4 +1,4 @@
-import { MethodsForSelecting, SnappingMethods } from "../enums";
+import { CollectionModes, MethodsForSelecting, SnappingMethods } from "../enums";
 import { Directions } from "../enums/directions";
 export declare const DEFAULT_ITEM_SIZE = 24;
 export declare const DEFAULT_BUFFER_SIZE = 2;
@@ -11,6 +11,7 @@ export declare const DEFAULT_ENABLED_BUFFER_OPTIMIZATION = false;
 export declare const DEFAULT_DYNAMIC_SIZE = false;
 export declare const TRACK_BY_PROPERTY_NAME = "id";
 export declare const DEFAULT_DIRECTION = Directions.VERTICAL;
+export declare const DEFAULT_COLLECTION_MODE = CollectionModes.NORMAL;
 export declare const DISPLAY_OBJECTS_LENGTH_MESUREMENT_ERROR = 1;
 export declare const MAX_SCROLL_TO_ITERATIONS = 5;
 export declare const DEFAULT_SNAPPING_METHOD = SnappingMethods.NORMAL;

package/lib/enums/collection-mode.d.ts

@@ -0,0 +1,8 @@
+import { CollectionModes } from "./collection-modes";
+/**
+ * Action modes for collection elements.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/enums/collection-mode.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export type CollectionMode = CollectionModes | 'normal' | 'lazy';

package/lib/enums/collection-modes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Action modes for collection elements.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/enums/collection-modes.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare enum CollectionModes {
+    /**
+     * When adding elements to the beginning of the collection, the scroll remains at the current position.
+     */
+    NORMAL = "normal",
+    /**
+     * When adding elements to the beginning of the collection, the scroll is shifted by the sum of the sizes of the new elements.
+     */
+    LAZY = "lazy"
+}

package/lib/enums/focus-alignments.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Focus Alignments.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/enums/focus-alignments.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare enum FocusAlignments {
+    NONE = "none",
+    START = "start",
+    CENTER = "center",
+    END = "end"
+}

package/lib/enums/index.d.ts

@@ -1,8 +1,11 @@
+import { CollectionMode } from "./collection-mode";
+import { CollectionModes } from "./collection-modes";
 import { Directions } from "./directions";
 import { Direction } from "./direction";
 import { MethodsForSelecting } from "./methods-for-selecting";
 import { MethodForSelecting } from "./method-for-selecting";
 import { SnappingMethods } from "./snapping-methods";
 import { SnappingMethod } from "./snapping-method";
-export { Directions, MethodsForSelecting, SnappingMethods, };
-export type { Direction, MethodForSelecting, SnappingMethod, };
+import { FocusAlignments } from "./focus-alignments";
+export { CollectionModes, Directions, MethodsForSelecting, SnappingMethods, FocusAlignments, };
+export type { CollectionMode, Direction, MethodForSelecting, SnappingMethod, };

package/lib/models/display-object-config.model.d.ts

@@ -0,0 +1,35 @@
+import { IRenderVirtualListItemConfig } from "./render-item-config.model";
+/**
+ * Display object configuration. A set of `select`, `collapse`, and `focus` methods are also provided.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/display-object-config.model.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IDisplayObjectConfig extends IRenderVirtualListItemConfig {
+    /**
+     * Determines whether the element has focused or not.
+     */
+    focused: boolean;
+    /**
+     * Determines whether the element is selected or not.
+     */
+    selected: boolean;
+    /**
+     * Determines whether the element is collapsed or not.
+     */
+    collapsed: boolean;
+    /**
+      * Focus a list item
+      */
+    focus: () => void;
+    /**
+      * Selects a list item
+      * @param selected - If the value is undefined, then the toggle method is executed, if false or true, then the selection/deselection is performed.
+      */
+    select: (selected: boolean | undefined) => void;
+    /**
+      * Collapse list items
+      * @param collapsed - If the value is undefined, then the toggle method is executed, if false or true, then the collapse/expand is performed.
+      */
+    collapse: (collapsed: boolean | undefined) => void;
+}

package/lib/models/display-object-measures.model.d.ts

@@ -0,0 +1,13 @@
+import { IRect } from "../types";
+/**
+ * Display object metrics.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/display-object-measures.model.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IDisplayObjectMeasures extends IRect {
+    /**
+     * Delta is calculated for Snapping Method.ADVANCED
+     */
+    delta: number;
+}

package/lib/models/index.d.ts

@@ -4,4 +4,6 @@ import { IVirtualListItem } from './item.model';
 import { IVirtualListItemConfigMap } from './item-config-map.model';
 import { IVirtualListCollection } from './collection.model';
 import { IRenderVirtualListItem } from './render-item.model';
-export type { ScrollDirection, IScrollEvent, IVirtualListItem, IVirtualListItemConfigMap, IVirtualListCollection, IRenderVirtualListItem, };
+import { IDisplayObjectConfig } from './display-object-config.model';
+import { IDisplayObjectMeasures } from './display-object-measures.model';
+export type { IDisplayObjectConfig, IDisplayObjectMeasures, IScrollEvent, IVirtualListItem, IVirtualListItemConfigMap, IVirtualListCollection, IRenderVirtualListItem, ScrollDirection, };

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

@@ -1,8 +1,8 @@
 import { AfterViewInit, OnDestroy, OnInit, TemplateRef, WritableSignal } from '@angular/core';
 import { Observable } from 'rxjs';
 import { IRenderVirtualListItem, IScrollEvent, IVirtualListCollection, IVirtualListItemConfigMap } from './models';
-import { Id, ISize } from './types';
-import { Direction, Directions, MethodForSelecting, SnappingMethod } from './enums';
+import { FocusAlignment, Id, ISize } from './types';
+import { CollectionMode, Direction, Directions, MethodForSelecting, SnappingMethod } from './enums';
 import * as i0 from "@angular/core";
 /**
  * Virtual list component.
@@ -131,6 +131,11 @@ 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 _collectionModeOptions;
+    /**
+     * Determines the action modes for collection elements. Default value is "normal".
+     */
+    collectionMode: import("@angular/core").InputSignal<CollectionMode>;
     private _bufferSizeOptions;
     /**
      * Number of elements outside the scope of visibility. Default value is 2.
@@ -171,6 +176,7 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     get isMultiSelecting(): boolean;
     private _isSnappingMethodAdvanced;
     get isSnappingMethodAdvanced(): boolean;
+    private _isLazy;
     private _isVertical;
     get orientation(): Directions;
     readonly focusedElement: WritableSignal<Id | undefined>;
@@ -206,6 +212,8 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     private _trackBox;
     private _onTrackBoxChangeHandler;
     private _cacheVersion;
+    private _isResetedReachStart;
+    private _onTrackBoxResetHandler;
     constructor();
     ngOnInit(): void;
     private onInit;
@@ -215,6 +223,7 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     private getIsSingleSelecting;
     private getIsMultiSelecting;
     private getIsVertical;
+    private getIsLazy;
     private createDisplayComponentsIfNeed;
     private updateRegularRenderer;
     private resetRenderers;
@@ -227,6 +236,10 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Returns the bounds of an element with a given id
      */
     getItemBounds(id: Id): ISize | undefined;
+    /**
+     * Focus an list item by a given id.
+     */
+    focus(id: Id, align?: FocusAlignment): void;
     /**
      * 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".
@@ -246,5 +259,5 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     ngOnDestroy(): void;
     private dispose;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": { "alias": "items"; "required": true; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "collapsedIds": { "alias": "collapsedIds"; "required": false; "isSignal": true; }; "selectByClick": { "alias": "selectByClick"; "required": false; "isSignal": true; }; "collapseByClick": { "alias": "collapseByClick"; "required": false; "isSignal": true; }; "snap": { "alias": "snap"; "required": false; "isSignal": true; }; "enabledBufferOptimization": { "alias": "enabledBufferOptimization"; "required": false; "isSignal": true; }; "itemRenderer": { "alias": "itemRenderer"; "required": true; "isSignal": true; }; "itemConfigMap": { "alias": "itemConfigMap"; "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; }; "bufferSize": { "alias": "bufferSize"; "required": false; "isSignal": true; }; "maxBufferSize": { "alias": "maxBufferSize"; "required": false; "isSignal": true; }; "snappingMethod": { "alias": "snappingMethod"; "required": false; "isSignal": true; }; "methodForSelecting": { "alias": "methodForSelecting"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; "onViewportChange": "onViewportChange"; "onItemClick": "onItemClick"; "onSelect": "onSelect"; "onCollapse": "onCollapse"; "onScrollReachStart": "onScrollReachStart"; "onScrollReachEnd": "onScrollReachEnd"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": { "alias": "items"; "required": true; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "collapsedIds": { "alias": "collapsedIds"; "required": false; "isSignal": true; }; "selectByClick": { "alias": "selectByClick"; "required": false; "isSignal": true; }; "collapseByClick": { "alias": "collapseByClick"; "required": false; "isSignal": true; }; "snap": { "alias": "snap"; "required": false; "isSignal": true; }; "enabledBufferOptimization": { "alias": "enabledBufferOptimization"; "required": false; "isSignal": true; }; "itemRenderer": { "alias": "itemRenderer"; "required": true; "isSignal": true; }; "itemConfigMap": { "alias": "itemConfigMap"; "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; }; "collectionMode": { "alias": "collectionMode"; "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; }; "methodForSelecting": { "alias": "methodForSelecting"; "required": false; "isSignal": true; }; "trackBy": { "alias": "trackBy"; "required": false; "isSignal": true; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; "onViewportChange": "onViewportChange"; "onItemClick": "onItemClick"; "onSelect": "onSelect"; "onCollapse": "onCollapse"; "onScrollReachStart": "onScrollReachStart"; "onScrollReachEnd": "onScrollReachEnd"; }, never, never, false, never>;
 }

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

@@ -1,8 +1,8 @@
 import { TrackBox } from './utils/trackBox';
 import { IRenderVirtualListItem } from './models';
-import { Id } from './types';
-import { MethodsForSelectingTypes } from './enums/method-for-selecting-types';
 import { IRenderVirtualListCollection } from './models/render-collection.model';
+import { MethodsForSelectingTypes } from './enums/method-for-selecting-types';
+import { FocusAlignment, Id } from './types';
 import * as i0 from "@angular/core";
 export declare class NgVirtualListService {
     private _nextComponentId;
@@ -40,8 +40,8 @@ export declare class NgVirtualListService {
       * @param collapsed - If the value is undefined, then the toggle method is executed, if false or true, then the collapse/expand is performed.
       */
     collapse(data: IRenderVirtualListItem | undefined, collapsed?: boolean | undefined): void;
-    itemToFocus: ((element: HTMLElement, position: number) => void) | undefined;
-    focus(element: HTMLElement): void;
+    itemToFocus: ((element: HTMLElement, position: number, align: FocusAlignment) => void) | undefined;
+    focus(element: HTMLElement, align?: FocusAlignment): void;
     areaFocus(id: Id | null): void;
     initialize(trackBox: TrackBox): void;
     generateComponentId(): number;

package/lib/types/focus-alignment.d.ts

@@ -0,0 +1,8 @@
+import { FocusAlignments } from "../enums";
+/**
+ * Focus Alignment
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/focus-alignment.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export type FocusAlignment = FocusAlignments | 'none' | 'start' | 'center' | 'end';

package/lib/types/index.d.ts

@@ -1,4 +1,5 @@
 import { Id } from './id';
 import { ISize } from './size';
 import { IRect } from './rect';
-export type { Id, ISize, IRect, };
+import { FocusAlignment } from './focus-alignment';
+export type { Id, ISize, IRect, FocusAlignment, };

package/lib/utils/isCollectionMode.d.ts

@@ -0,0 +1,8 @@
+import { CollectionMode } from "../enums";
+/**
+ * Determines the axis membership of a virtual list
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/utils/isCollectionMode.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare const isCollectionMode: (src: CollectionMode, expected: CollectionMode) => boolean;

package/lib/utils/trackBox.d.ts

@@ -7,7 +7,10 @@ import { ISize } from "../types";
 import { HEIGHT_PROP_NAME, WIDTH_PROP_NAME } from "../const";
 import { IVirtualListItemConfigMap } from "../models";
 import { BaseVirtualListItemComponent } from "../models/base-virtual-list-item-component";
-export declare const TRACK_BOX_CHANGE_EVENT_NAME = "change";
+export declare enum TrackBoxEvents {
+    CHANGE = "change",
+    RESET = "reset"
+}
 export interface IMetrics {
     delta: number;
     normalizedItemWidth: number;
@@ -68,9 +71,10 @@ export interface IUpdateCollectionOptions<I extends {
     id: Id;
 }, C extends Array<I>> extends Omit<IRecalculateMetricsOptions<I, C>, 'collection' | 'previousTotalSize' | 'crudDetected' | 'deletedItemsMap'> {
 }
-export type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
+export type CacheMapEvents = TrackBoxEvents.CHANGE | TrackBoxEvents.RESET;
 export type OnChangeEventListener = (version: number) => void;
-export type CacheMapListeners = OnChangeEventListener;
+export type OnResetEventListener = (reseted: boolean) => void;
+export type CacheMapListeners = OnChangeEventListener | OnResetEventListener;
 export declare enum ItemDisplayMethods {
     CREATE = 0,
     UPDATE = 1,
@@ -83,17 +87,18 @@ export interface IUpdateCollectionReturns {
     delta: number;
     crudDetected: boolean;
 }
+type Cache = ISize & {
+    method?: ItemDisplayMethods;
+} & {
+    [prop: string]: any;
+};
 /**
  * An object that performs tracking, calculations and caching.
  * @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
  */
-export declare class TrackBox<C extends BaseVirtualListItemComponent = any> extends CacheMap<Id, ISize & {
-    method?: ItemDisplayMethods;
-} & {
-    [prop: string]: any;
-}, CacheMapEvents, CacheMapListeners> {
+export declare class TrackBox<C extends BaseVirtualListItemComponent = any> extends CacheMap<Id, Cache, CacheMapEvents, CacheMapListeners> {
     protected _tracker: Tracker<C>;
     protected _items: IRenderVirtualListCollection | null | undefined;
     set items(v: IRenderVirtualListCollection | null | undefined);
@@ -103,6 +108,8 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
     set snapedDisplayComponent(v: ComponentRef<C> | null | undefined);
     protected _isSnappingMethodAdvanced: boolean;
     set isSnappingMethodAdvanced(v: boolean);
+    protected _isLazy: boolean;
+    set isLazy(v: boolean);
     /**
      * Set the trackBy property
      */
@@ -133,7 +140,7 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
     protected _maxBufferSize: number;
     protected _resetBufferSizeTimeout: number;
     protected _resetBufferSizeTimer: number | undefined;
-    protected isInit: boolean;
+    protected isReseted: boolean;
     protected lifeCircle(): void;
     /**
      * Scans the collection for deleted items and flushes the deleted item cache.
@@ -208,3 +215,4 @@ export declare class TrackBox<C extends BaseVirtualListItemComponent = any> exte
     protected cacheElements(): void;
     dispose(): void;
 }
+export {};

package/package.json

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