ng-virtual-list 20.4.1 → 20.4.2

package/lib/utils/index.d.ts

@@ -1,9 +0,0 @@
-import { isDirection } from "./isDirection";
-import { debounce } from "./debounce";
-import { toggleClassName } from './toggleClassName';
-import { Tracker } from "./tracker";
-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, 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/isDirection.d.ts

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

package/lib/utils/scrollEvent.d.ts

@@ -1,39 +0,0 @@
-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/15.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;
-    private _scrollSize;
-    get scrollSize(): number;
-    private _scrollWeight;
-    get scrollWeight(): number;
-    private _isVertical;
-    get isVertical(): boolean;
-    private _listSize;
-    get listSize(): number;
-    private _size;
-    get size(): number;
-    private _isStart;
-    get isStart(): boolean;
-    private _isEnd;
-    get isEnd(): boolean;
-    private _delta;
-    get delta(): number;
-    private _scrollDelta;
-    get scrollDelta(): number;
-    constructor(params: IScrollEventParams);
-}
-export {};

package/lib/utils/snapping-method.d.ts

@@ -1,3 +0,0 @@
-import { SnappingMethod } from "../enums";
-export declare const isSnappingMethodAdvenced: (method: SnappingMethod) => boolean;
-export declare const isSnappingMethodDefault: (method: SnappingMethod) => boolean;

package/lib/utils/toggleClassName.d.ts

@@ -1,7 +0,0 @@
-/**
- * Switch css classes
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/15.x/projects/ng-virtual-list/src/lib/utils/toggleClassName.ts
- * @author Evgenii Grebennikov
- * @email djonnyx@gmail.com
- */
-export declare const toggleClassName: (el: HTMLElement, className: string, removeClassName?: string) => void;

package/lib/utils/trackBox.d.ts

@@ -1,204 +0,0 @@
-import { ComponentRef } from "@angular/core";
-import { IRenderVirtualListCollection } from "../models/render-collection.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 { BaseVirtualListItemComponent, 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;
-    itemsOnDisplayWeight: number;
-    itemsOnDisplayLength: number;
-    isVertical: boolean;
-    leftHiddenItemsWeight: number;
-    leftItemLength: number;
-    leftItemsWeight: number;
-    renderItems: number;
-    rightItemLength: number;
-    rightItemsWeight: number;
-    scrollSize: number;
-    leftSizeOfAddedItems: 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;
-    isFromItemIdFound: boolean;
-}
-export interface IRecalculateMetricsOptions<I extends {
-    id: Id;
-}, C extends Array<I>> {
-    bounds: ISize;
-    collection: C;
-    isVertical: boolean;
-    itemSize: number;
-    bufferSize: number;
-    maxBufferSize: number;
-    dynamicSize: boolean;
-    scrollSize: number;
-    snap: boolean;
-    enabledBufferOptimization: boolean;
-    fromItemId?: Id;
-    previousTotalSize: number;
-    crudDetected: boolean;
-    deletedItemsMap: {
-        [index: number]: ISize;
-    };
-}
-export interface IGetItemPositionOptions<I extends {
-    id: Id;
-}, C extends Array<I>> extends Omit<IRecalculateMetricsOptions<I, C>, 'previousTotalSize' | 'crudDetected' | 'deletedItemsMap'> {
-}
-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 OnChangeEventListener = (version: number) => void;
-export type CacheMapListeners = OnChangeEventListener;
-export declare enum ItemDisplayMethods {
-    CREATE = 0,
-    UPDATE = 1,
-    DELETE = 2,
-    NOT_CHANGED = 3
-}
-export interface IUpdateCollectionReturns {
-    displayItems: IRenderVirtualListCollection;
-    totalSize: number;
-    delta: number;
-    crudDetected: boolean;
-}
-/**
- * An object that performs tracking, calculations and caching.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/15.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;
-}, CacheMapEvents, CacheMapListeners> {
-    protected _tracker: Tracker<C>;
-    protected _items: IRenderVirtualListCollection | null | undefined;
-    set items(v: IRenderVirtualListCollection | 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);
-    /**
-     * Set the trackBy property
-     */
-    set trackingPropertyName(v: string);
-    constructor(trackingPropertyName: string);
-    set(id: Id, bounds: ISize): CMap<Id, ISize>;
-    protected _previousCollection: Array<{
-        id: Id;
-    }> | null | undefined;
-    protected _deletedItemsMap: {
-        [index: number]: ISize;
-    };
-    protected _crudDetected: boolean;
-    get crudDetected(): boolean;
-    protected fireChangeIfNeed(): void;
-    protected _previousTotalSize: number;
-    protected _scrollDelta: number;
-    get scrollDelta(): number;
-    isAdaptiveBuffer: boolean;
-    protected _bufferSequenceExtraThreshold: number;
-    protected _maxBufferSequenceLength: number;
-    protected _bufferSizeSequence: Array<number>;
-    protected _bufferSize: number;
-    get bufferSize(): number;
-    protected _defaultBufferSize: number;
-    protected _maxBufferSize: number;
-    protected _resetBufferSizeTimeout: number;
-    protected _resetBufferSizeTimer: number | undefined;
-    protected lifeCircle(): void;
-    /**
-     * Scans the collection for deleted items and flushes the deleted item cache.
-     */
-    resetCollection<I extends {
-        id: Id;
-    }, C extends Array<I>>(currentCollection: C | null | undefined, itemSize: number): void;
-    /**
-     * Update the cache of items from the list
-     */
-    protected updateCache<I extends {
-        id: Id;
-    }, C extends Array<I>>(previousCollection: C | null | undefined, currentCollection: C | null | undefined, itemSize: number): void;
-    /**
-     * Finds the position of a collection element by the given Id
-     */
-    getItemPosition<I extends {
-        id: Id;
-    }, C extends Array<I>>(id: Id, stickyMap: IVirtualListStickyMap, options: IGetItemPositionOptions<I, C>): number;
-    /**
-     * Updates the collection of display objects
-     */
-    updateCollection<I extends {
-        id: Id;
-    }, C extends Array<I>>(items: C, stickyMap: IVirtualListStickyMap, options: IUpdateCollectionOptions<I, C>): IUpdateCollectionReturns;
-    /**
-     * Finds the closest element in the collection by scrollSize
-     */
-    getNearestItem<I extends {
-        id: Id;
-    }, C extends Array<I>>(scrollSize: number, items: C, itemSize: number, isVertical: boolean): I | undefined;
-    protected _previousScrollSize: number;
-    protected updateAdaptiveBufferParams(metrics: IMetrics, totalItemsLength: number): void;
-    protected startResetBufferSizeTimer(): void;
-    protected disposeClearBufferSizeTimer(): void;
-    /**
-     * Calculates the position of an element based on the given scrollSize
-     */
-    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
-     */
-    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
-     */
-    protected recalculateMetrics<I extends {
-        id: Id;
-    }, C extends Array<I>>(options: IRecalculateMetricsOptions<I, C>): IMetrics;
-    clearDeltaDirection(): void;
-    clearDelta(clearDirectionDetector?: boolean): void;
-    changes(): 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?: C | undefined): void;
-    getItemBounds(id: Id): ISize | undefined;
-    protected cacheElements(): void;
-    dispose(): void;
-}

package/lib/utils/tracker.d.ts

@@ -1,46 +0,0 @@
-import { ComponentRef } from "@angular/core";
-import { BaseVirtualListItemComponent, ScrollDirection } from "../models";
-import { Id, ISize } from "../types";
-export interface IVirtualListItemComponent<I = any> {
-    getBounds(): ISize;
-    itemId: Id;
-    id: number;
-    item: I | null;
-    show: () => void;
-    hide: () => void;
-}
-/**
- * Tracks display items by property
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/15.x/projects/ng-virtual-list/src/lib/utils/tracker.ts
- * @author Evgenii Grebennikov
- * @email djonnyx@gmail.com
- */
-export declare class Tracker<C extends BaseVirtualListItemComponent = 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;
-    set trackingPropertyName(v: string);
-    constructor(trackingPropertyName: string);
-    /**
-     * tracking by propName
-     */
-    track(items: Array<any>, components: Array<ComponentRef<C>>, snapedComponent: ComponentRef<C> | null | undefined, direction: ScrollDirection): void;
-    untrackComponentByIdProperty(component?: C): void;
-    dispose(): void;
-}

package/public-api.d.ts

@@ -1,6 +0,0 @@
-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';
-export * from './lib/models';
-export * from './lib/types';