ng-virtual-list 16.2.0 → 16.3.0

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

@@ -1,6 +1,7 @@
 import { ChangeDetectorRef, ElementRef, TemplateRef } from '@angular/core';
 import { IRenderVirtualListItem } from '../models/render-item.model';
 import { ISize } from '../types';
+import { BaseVirtualListItemComponent } from '../models';
 import * as i0 from "@angular/core";
 /**
  * Virtual list item component
@@ -8,7 +9,7 @@ import * as i0 from "@angular/core";
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export declare class NgVirtualListItemComponent {
+export declare class NgVirtualListItemComponent extends BaseVirtualListItemComponent {
     private _cdr;
     private _elementRef;
     private static __nextId;

package/lib/enums/direction.d.ts

@@ -5,4 +5,4 @@ import { Directions } from "./directions";
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export type Direction = Directions | 'hotizontal' | 'vertical';
+export type Direction = Directions | 'horizontal' | 'vertical';

package/lib/models/base-virtual-list-item-component.d.ts

@@ -0,0 +1,25 @@
+import { TemplateRef } from '@angular/core';
+import { Id, ISize } from '../types';
+import { IRenderVirtualListItem } from './render-item.model';
+/**
+ * Virtual List Item Interface
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/16.x/projects/ng-virtual-list/src/lib/models/base-virtual-list-item-component.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare abstract class BaseVirtualListItemComponent {
+    abstract get id(): number;
+    abstract data: IRenderVirtualListItem | undefined;
+    abstract regular: boolean;
+    abstract set regularLength(v: string);
+    abstract set item(v: IRenderVirtualListItem | null | undefined);
+    abstract get item(): IRenderVirtualListItem | null | undefined;
+    abstract get itemId(): Id | undefined;
+    abstract itemRenderer: TemplateRef<any> | undefined;
+    abstract set renderer(v: TemplateRef<any> | undefined);
+    abstract get element(): HTMLElement;
+    protected abstract update(): void;
+    abstract getBounds(): ISize;
+    abstract show(): void;
+    abstract hide(): void;
+}

package/lib/models/collection.model.d.ts

@@ -5,5 +5,5 @@ import { IVirtualListItem } from "./item.model";
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export interface IVirtualListCollection extends Array<IVirtualListItem> {
+export interface IVirtualListCollection<E = Object> extends Array<IVirtualListItem<E>> {
 }

package/lib/models/component.model.d.ts

@@ -0,0 +1,3 @@
+export interface Component$1<T> extends Function {
+    new (...args: any[]): T;
+}

package/lib/models/index.d.ts

@@ -3,4 +3,7 @@ import { IScrollEvent } from './scroll-event.model';
 import { IVirtualListItem } from './item.model';
 import { IVirtualListStickyMap } from './sticky-map.model';
 import { IVirtualListCollection } from './collection.model';
-export type { ScrollDirection, IScrollEvent, IVirtualListItem, IVirtualListStickyMap, IVirtualListCollection, };
+import { BaseVirtualListItemComponent } from './base-virtual-list-item-component';
+import { Component$1 } from './component.model';
+export type { ScrollDirection, IScrollEvent, IVirtualListItem, IVirtualListStickyMap, IVirtualListCollection, Component$1, };
+export { BaseVirtualListItemComponent, };

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

@@ -5,10 +5,10 @@ import { Id } from "../types/id";
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export interface IVirtualListItem {
+export type IVirtualListItem<E = Object> = E & {
     /**
      * Unique identifier of the element.
      */
     id: Id;
     [x: string]: any;
-}
+};

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

@@ -1,9 +1,10 @@
 import { AfterViewInit, ChangeDetectorRef, ComponentRef, ElementRef, EventEmitter, OnDestroy, OnInit, TemplateRef, ViewContainerRef } from '@angular/core';
 import { BehaviorSubject, Observable } from 'rxjs';
-import { NgVirtualListItemComponent } from './components/ng-virtual-list-item.component';
-import { IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
+import { BaseVirtualListItemComponent, Component$1, IScrollEvent, IVirtualListCollection, IVirtualListStickyMap } from './models';
 import { Id, ISize } from './types';
+import { IRenderVirtualListCollection } from './models/render-collection.model';
 import { Direction, SnappingMethod } from './enums';
+import { TrackBox } from './utils';
 import * as i0 from "@angular/core";
 /**
  * Virtual list component.
@@ -14,10 +15,10 @@ import * as i0 from "@angular/core";
  * @email djonnyx@gmail.com
  */
 export declare class NgVirtualListComponent implements AfterViewInit, OnInit, OnDestroy {
-    private _cdr;
-    private _elementRef;
-    private static __nextId;
-    private _id;
+    protected _cdr: ChangeDetectorRef;
+    protected _elementRef: ElementRef<HTMLDivElement>;
+    protected static __nextId: number;
+    protected _id: number;
     /**
      * Readonly. Returns the unique identifier of the component.
      */
@@ -35,22 +36,22 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Fires when the list has completed scrolling.
      */
     onScrollEnd: EventEmitter<IScrollEvent>;
-    private _$items;
-    readonly $items: Observable<IVirtualListCollection | undefined>;
-    private _itemsTransform;
+    protected _$items: BehaviorSubject<IVirtualListCollection<Object> | undefined>;
+    readonly $items: Observable<IVirtualListCollection<Object> | undefined>;
+    protected _itemsTransform: (v: IVirtualListCollection | undefined) => IVirtualListCollection<Object> | undefined;
     /**
      * Collection of list items.
      */
     set items(v: IVirtualListCollection);
     get items(): IVirtualListCollection;
-    private _$snap;
+    protected _$snap: BehaviorSubject<boolean>;
     readonly $snap: Observable<boolean>;
     /**
      * Determines whether elements will snap. Default value is "true".
      */
     set snap(v: boolean);
     get snap(): boolean;
-    private _$enabledBufferOptimization;
+    protected _$enabledBufferOptimization: BehaviorSubject<boolean>;
     readonly $enabledBufferOptimization: Observable<boolean>;
     /**
      * Experimental!
@@ -60,14 +61,15 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      */
     set enabledBufferOptimization(v: boolean);
     get enabledBufferOptimization(): boolean;
-    private _$itemRenderer;
+    protected _$itemRenderer: BehaviorSubject<TemplateRef<any> | undefined>;
     readonly $itemRenderer: Observable<TemplateRef<any> | undefined>;
+    protected _$renderer: BehaviorSubject<TemplateRef<any> | undefined>;
     /**
     * Rendering element template.
     */
     set itemRenderer(v: TemplateRef<any>);
     get itemRenderer(): TemplateRef<any>;
-    private _$stickyMap;
+    protected _$stickyMap: BehaviorSubject<IVirtualListStickyMap>;
     readonly $stickyMap: Observable<IVirtualListStickyMap>;
     /**
      * Dictionary zIndex by id of the list element. If the value is not set or equal to 0,
@@ -75,8 +77,8 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      */
     set stickyMap(v: IVirtualListStickyMap);
     get stickyMap(): IVirtualListStickyMap;
-    private _itemSizeOptions;
-    private _$itemSize;
+    protected _itemSizeOptions: (v: number | undefined) => number;
+    protected _$itemSize: BehaviorSubject<number>;
     readonly $itemSize: Observable<number>;
     /**
      * If direction = 'vertical', then the height of a typical element. If direction = 'horizontal', then the width of a typical element.
@@ -84,7 +86,7 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      */
     set itemSize(v: number);
     get itemSize(): number;
-    private _$dynamicSize;
+    protected _$dynamicSize: BehaviorSubject<boolean>;
     readonly $dynamicSize: Observable<boolean>;
     /**
      * If true then the items in the list can have different sizes and the itemSize property is ignored.
@@ -92,29 +94,29 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      */
     set dynamicSize(v: boolean);
     get dynamicSize(): boolean;
-    private _$direction;
+    protected _$direction: BehaviorSubject<Direction>;
     readonly $direction: Observable<Direction>;
     /**
      * Determines the direction in which elements are placed. Default value is "vertical".
      */
     set direction(v: Direction);
     get direction(): Direction;
-    private _$itemsOffset;
+    protected _$itemsOffset: BehaviorSubject<number>;
     readonly $itemsOffset: Observable<number>;
     /**
      * Number of elements outside the scope of visibility. Default value is 2.
      */
     set itemsOffset(v: number);
     get itemsOffset(): number;
-    private _$trackBy;
+    protected _$trackBy: BehaviorSubject<string>;
     readonly $trackBy: Observable<string>;
     /**
      * The name of the property by which tracking is performed
      */
     set trackBy(v: string);
     get trackBy(): string;
-    private _isVertical;
-    private _$snappingMethod;
+    protected _isVertical: boolean;
+    protected _$snappingMethod: BehaviorSubject<SnappingMethod>;
     readonly $snappingMethod: Observable<SnappingMethod>;
     /**
      * Snapping method.
@@ -125,39 +127,49 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
     get snappingMethod(): SnappingMethod;
     protected _isSnappingMethodAdvanced: boolean;
     get isSnappingMethodAdvanced(): boolean;
-    protected _displayComponents: Array<ComponentRef<NgVirtualListItemComponent>>;
-    protected _snapedDisplayComponent: ComponentRef<NgVirtualListItemComponent> | undefined;
+    protected _displayComponents: Array<ComponentRef<BaseVirtualListItemComponent>>;
+    protected _snapedDisplayComponent: ComponentRef<BaseVirtualListItemComponent> | undefined;
     protected _$bounds: BehaviorSubject<ISize | null>;
     protected _$scrollSize: BehaviorSubject<number>;
-    private _resizeObserver;
-    private _resizeSnappedComponentHandler;
-    private _resizeSnappedObserver;
-    private _onResizeHandler;
-    private _onScrollHandler;
-    private _$initialized;
+    protected _resizeObserver: ResizeObserver | null;
+    protected _resizeSnappedComponentHandler: () => void;
+    protected _resizeSnappedObserver: ResizeObserver | null;
+    protected _onResizeHandler: () => void;
+    protected _onScrollHandler: (e?: Event) => void;
+    protected _$initialized: BehaviorSubject<boolean>;
     readonly $initialized: Observable<boolean>;
+    /**
+     * Base class of the element component
+     */
+    protected _itemComponentClass: Component$1<BaseVirtualListItemComponent>;
+    /**
+     * Base class trackBox
+     */
+    protected _trackBoxClass: Component$1<TrackBox>;
     /**
      * Dictionary of element sizes by their id
      */
-    private _trackBox;
-    private _onTrackBoxChangeHandler;
-    private _$cacheVersion;
+    protected _trackBox: TrackBox;
+    protected _onTrackBoxChangeHandler: (v: number) => void;
+    protected _$cacheVersion: BehaviorSubject<number>;
     get $cacheVersion(): Observable<number>;
     constructor(_cdr: ChangeDetectorRef, _elementRef: ElementRef<HTMLDivElement>);
+    protected setupRenderer(): void;
     /** @internal */
     ngOnInit(): void;
-    private listenCacheChangesIfNeed;
-    private getIsSnappingMethodAdvanced;
-    private getIsVertical;
-    private _componentsResizeObserver;
-    private createDisplayComponentsIfNeed;
-    private updateRegularRenderer;
-    private resetRenderers;
+    protected onInit(): void;
+    protected listenCacheChangesIfNeed(value: boolean): void;
+    protected getIsSnappingMethodAdvanced(m?: SnappingMethod): boolean;
+    protected getIsVertical(d?: Direction): boolean;
+    protected _componentsResizeObserver: ResizeObserver;
+    protected createDisplayComponentsIfNeed(displayItems: IRenderVirtualListCollection | null): void;
+    protected updateRegularRenderer(): void;
+    protected resetRenderers(itemRenderer?: TemplateRef<HTMLElement>): void;
     /**
      * Tracking by id
      */
     protected tracking(): void;
-    private resetBoundsSize;
+    protected resetBoundsSize(isVertical: boolean, totalSize: number): void;
     /**
      * Returns the bounds of an element with a given id
      */
@@ -167,19 +179,21 @@ export declare class NgVirtualListComponent implements AfterViewInit, OnInit, On
      * Behavior accepts the values ​​"auto", "instant" and "smooth".
      */
     scrollTo(id: Id, behavior?: ScrollBehavior): void;
-    private _scrollToRepeatExecutionTimeout;
-    private clearScrollToRepeatExecutionTimeout;
+    protected _scrollToRepeatExecutionTimeout: any;
+    protected clearScrollToRepeatExecutionTimeout(): void;
     protected scrollToExecutor(id: Id, behavior: ScrollBehavior, iteration?: number, isLastIteration?: boolean): void;
     /**
      * Scrolls the scroll area to the desired element with the specified ID.
      */
     scrollToEnd(behavior?: ScrollBehavior): void;
-    private _onContainerScrollHandler;
-    private _onContainerScrollEndHandler;
+    protected _onContainerScrollHandler: (e: Event) => void;
+    protected _onContainerScrollEndHandler: (e: Event) => void;
     /** @internal */
     ngAfterViewInit(): void;
+    protected afterViewInit(): void;
     /** @internal */
     ngOnDestroy(): void;
+    protected dispose(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": { "alias": "items"; "required": false; }; "snap": { "alias": "snap"; "required": false; }; "enabledBufferOptimization": { "alias": "enabledBufferOptimization"; "required": false; }; "itemRenderer": { "alias": "itemRenderer"; "required": false; }; "stickyMap": { "alias": "stickyMap"; "required": false; }; "itemSize": { "alias": "itemSize"; "required": false; }; "dynamicSize": { "alias": "dynamicSize"; "required": false; }; "direction": { "alias": "direction"; "required": false; }; "itemsOffset": { "alias": "itemsOffset"; "required": false; }; "trackBy": { "alias": "trackBy"; "required": false; }; "snappingMethod": { "alias": "snappingMethod"; "required": false; }; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; }, never, never, false, never>;
 }

package/lib/utils/index.d.ts

@@ -2,6 +2,8 @@ import { isDirection } from "./isDirection";
 import { debounce } from "./debounce";
 import { toggleClassName } from './toggleClassName';
 import { Tracker } from "./tracker";
-import { TrackBox } from "./trackBox";
+import { TrackBox, IUpdateCollectionReturns, TRACK_BOX_CHANGE_EVENT_NAME, IMetrics, IRecalculateMetricsOptions, IGetItemPositionOptions, IUpdateCollectionOptions, CacheMapEvents, OnChangeEventListener, CacheMapListeners, ItemDisplayMethods } from "./trackBox";
+import { CMap, ICacheMap, CACHE_BOX_CHANGE_EVENT_NAME } from './cacheMap';
 import { ScrollEvent } from "./scrollEvent";
-export { isDirection, debounce, toggleClassName, ScrollEvent, TrackBox, Tracker, };
+export { isDirection, debounce, toggleClassName, ScrollEvent, TrackBox, Tracker, TRACK_BOX_CHANGE_EVENT_NAME, CMap, CACHE_BOX_CHANGE_EVENT_NAME, };
+export type { ICacheMap, IUpdateCollectionReturns, IMetrics, IRecalculateMetricsOptions, IGetItemPositionOptions, IUpdateCollectionOptions, CacheMapEvents, OnChangeEventListener, CacheMapListeners, ItemDisplayMethods, };

package/lib/utils/trackBox.d.ts

@@ -1,13 +1,11 @@
 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 { CacheMap, CMap } from "./cacheMap";
 import { Tracker } from "./tracker";
 import { ISize } from "../types";
 import { HEIGHT_PROP_NAME, WIDTH_PROP_NAME } from "../const";
-import { IVirtualListStickyMap } from "../models";
+import { BaseVirtualListItemComponent, IVirtualListStickyMap } from "../models";
 export declare const TRACK_BOX_CHANGE_EVENT_NAME = "change";
 export interface IMetrics {
     delta: number;
@@ -67,16 +65,16 @@ export interface IUpdateCollectionOptions<I extends {
     id: Id;
 }, C extends Array<I>> extends Omit<IRecalculateMetricsOptions<I, C>, 'collection' | 'previousTotalSize' | 'crudDetected' | 'deletedItemsMap'> {
 }
-type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
-type OnChangeEventListener = (version: number) => void;
-type CacheMapListeners = OnChangeEventListener;
-declare enum ItemDisplayMethods {
+export type CacheMapEvents = typeof TRACK_BOX_CHANGE_EVENT_NAME;
+export type OnChangeEventListener = (version: number) => void;
+export type CacheMapListeners = OnChangeEventListener;
+export declare enum ItemDisplayMethods {
     CREATE = 0,
     UPDATE = 1,
     DELETE = 2,
     NOT_CHANGED = 3
 }
-interface IUpdateCollectionReturns {
+export interface IUpdateCollectionReturns {
     displayItems: IRenderVirtualListCollection;
     totalSize: number;
     delta: number;
@@ -88,16 +86,16 @@ interface IUpdateCollectionReturns {
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export declare class TrackBox extends CacheMap<Id, ISize & {
+export declare class TrackBox<C extends BaseVirtualListItemComponent = any> extends CacheMap<Id, ISize & {
     method?: ItemDisplayMethods;
 }, CacheMapEvents, CacheMapListeners> {
-    protected _tracker: Tracker<IRenderVirtualListItem, NgVirtualListItemComponent>;
+    protected _tracker: Tracker<C>;
     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);
-    protected _snapedDisplayComponent: ComponentRef<NgVirtualListItemComponent> | null | undefined;
-    set snapedDisplayComponent(v: ComponentRef<NgVirtualListItemComponent> | null | undefined);
+    protected _displayComponents: Array<ComponentRef<C>> | null | undefined;
+    set displayComponents(v: Array<ComponentRef<C>> | null | undefined);
+    protected _snapedDisplayComponent: ComponentRef<C> | null | undefined;
+    set snapedDisplayComponent(v: ComponentRef<C> | null | undefined);
     protected _isSnappingMethodAdvanced: boolean;
     set isSnappingMethodAdvanced(v: boolean);
     /**
@@ -106,12 +104,16 @@ export declare class TrackBox extends CacheMap<Id, ISize & {
     set trackingPropertyName(v: string);
     constructor(trackingPropertyName: string);
     set(id: Id, bounds: ISize): CMap<Id, ISize>;
-    private _previousCollection;
-    private _deletedItemsMap;
-    private _crudDetected;
+    protected _previousCollection: Array<{
+        id: Id;
+    }> | null | undefined;
+    protected _deletedItemsMap: {
+        [index: number]: ISize;
+    };
+    protected _crudDetected: boolean;
     get crudDetected(): boolean;
     protected fireChangeIfNeed(): void;
-    private _previousTotalSize;
+    protected _previousTotalSize: number;
     protected _scrollDelta: number;
     get scrollDelta(): number;
     protected lifeCircle(): void;
@@ -148,11 +150,18 @@ export declare class TrackBox extends CacheMap<Id, ISize & {
     /**
      * Calculates the position of an element based on the given scrollSize
      */
-    private getElementFromStart;
+    protected getElementFromStart<I extends {
+        id: Id;
+    }, C extends Array<I>>(scrollSize: number, collection: C, map: CMap<Id, ISize>, typicalItemSize: number, isVertical: boolean): I | undefined;
     /**
      * Calculates the entry into the overscroll area and returns the number of overscroll elements
      */
-    private getElementNumToEnd;
+    protected getElementNumToEnd<I extends {
+        id: Id;
+    }, C extends Array<I>>(i: number, collection: C, map: CMap<Id, ISize>, typicalItemSize: number, size: number, isVertical: boolean, indexOffset?: number): {
+        num: number;
+        offset: number;
+    };
     /**
      * Calculates list metrics
      */
@@ -172,9 +181,8 @@ export declare class TrackBox extends CacheMap<Id, ISize & {
     setDisplayObjectIndexMapById(v: {
         [id: number]: number;
     }): void;
-    untrackComponentByIdProperty(component?: NgVirtualListItemComponent | undefined): void;
+    untrackComponentByIdProperty(component?: C | undefined): void;
     getItemBounds(id: Id): ISize | undefined;
     protected cacheElements(): void;
     dispose(): void;
 }
-export {};

package/lib/utils/tracker.d.ts

@@ -1,8 +1,11 @@
 import { ComponentRef } from "@angular/core";
-import { ScrollDirection } from "../models";
-interface IVirtualListItemComponent<I = any> {
+import { BaseVirtualListItemComponent, ScrollDirection } from "../models";
+import { Id, ISize } from "../types";
+export interface IVirtualListItemComponent<I = any> {
+    getBounds(): ISize;
+    itemId: Id;
     id: number;
-    item: I;
+    item: I | null;
     show: () => void;
     hide: () => void;
 }
@@ -12,7 +15,7 @@ interface IVirtualListItemComponent<I = any> {
  * @author Evgenii Grebennikov
  * @email djonnyx@gmail.com
  */
-export declare class Tracker<I = any, C extends IVirtualListItemComponent = any> {
+export declare class Tracker<C extends BaseVirtualListItemComponent = any> {
     /**
      * display objects dictionary of indexes by id
      */
@@ -41,4 +44,3 @@ export declare class Tracker<I = any, C extends IVirtualListItemComponent = any>
     untrackComponentByIdProperty(component?: C): void;
     dispose(): void;
 }
-export {};

package/package.json

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

package/public-api.d.ts

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