ng-virtual-list 14.7.13 → 14.7.15

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

@@ -1,35 +1,11 @@
 import { ChangeDetectorRef, ElementRef, 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 { BehaviorSubject, Subject } from 'rxjs';
-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/14.x/projects/ng-virtual-list/src/lib/components/ng-virtual-list-item.component.ts
@@ -48,15 +24,10 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     private _isSelected;
     private _isCollapsed;
     private _$config;
-    $config: import("rxjs").Observable<IItemConfig>;
-    measures: BehaviorSubject<(IRect & {
-        /**
-         * Delta is calculated for Snapping Method.ADVANCED
-         */
-        delta: number;
-    }) | undefined>;
-    private _$focus;
-    $focus: import("rxjs").Observable<boolean>;
+    $config: import("rxjs").Observable<IDisplayObjectConfig>;
+    measures: BehaviorSubject<IDisplayObjectMeasures | undefined>;
+    private _$focused;
+    $focused: import("rxjs").Observable<boolean>;
     private _$part;
     $part: import("rxjs").Observable<string>;
     regular: boolean;
@@ -73,9 +44,11 @@ export declare class NgVirtualListItemComponent extends BaseVirtualListItemCompo
     get element(): HTMLElement;
     private _selectHandler;
     private _collapseHandler;
+    private _focusHandler;
     constructor(_cdr: ChangeDetectorRef, _elementRef: ElementRef<HTMLElement>, _service: NgVirtualListService);
     private focusNext;
     private focusPrev;
+    private focus;
     private updateMeasures;
     private updateConfig;
     private update;
@@ -88,4 +61,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>;
 }
-export {};

package/lib/const/index.d.ts

@@ -16,6 +16,7 @@ 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;
 export declare const DEFAULT_SELECT_METHOD = MethodsForSelecting.NONE;
+export declare const DEFAULT_SCREEN_READER_MESSAGE = "Showing items $1 to $2";
 export declare const BEHAVIOR_AUTO = "auto";
 export declare const BEHAVIOR_INSTANT = "instant";
 export declare const BEHAVIOR_SMOOTH = "smooth";

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

@@ -0,0 +1,12 @@
+/**
+ * Focus Alignments.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.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

@@ -6,5 +6,6 @@ import { MethodsForSelecting } from "./methods-for-selecting";
 import { MethodForSelecting } from "./method-for-selecting";
 import { SnappingMethods } from "./snapping-methods";
 import { SnappingMethod } from "./snapping-method";
-export { CollectionModes, Directions, MethodsForSelecting, SnappingMethods, };
+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/14.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/14.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,6 +1,6 @@
 import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
 import { IRenderVirtualListItem, IScrollEvent, IVirtualListCollection, IVirtualListItemConfigMap } from './models';
-import { Id, ISize } from './types';
+import { FocusAlignment, Id, ISize } from './types';
 import { CollectionMode, Direction, Directions, MethodForSelecting, SnappingMethod } from './enums';
 import { DisposableComponent } from './utils/disposableComponent';
 import { NgVirtualListService } from './ng-virtual-list.service';
@@ -225,6 +225,19 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      */
     set trackBy(v: string);
     get trackBy(): string;
+    private _$screenReaderMessage;
+    readonly $screenReaderMessage: import("rxjs").Observable<string>;
+    private _screenReaderMessageTransform;
+    /**
+     * Message for screen reader.
+     * The message format is: "some text $1 some text $2",
+     * where $1 is the number of the first element of the screen collection,
+     * $2 is the number of the last element of the screen collection.
+     */
+    set screenReaderMessage(v: string);
+    get screenReaderMessage(): string;
+    private _$screenReaderFormattedMessage;
+    readonly $screenReaderFormattedMessage: import("rxjs").Observable<string>;
     private _isVertical;
     private _isLazy;
     get orientation(): Directions;
@@ -296,6 +309,10 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
      * 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".
@@ -315,5 +332,5 @@ export declare class NgVirtualListComponent extends DisposableComponent implemen
     ngOnDestroy(): void;
     private dispose;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": "items"; "selectedIds": "selectedIds"; "collapsedIds": "collapsedIds"; "selectByClick": "selectByClick"; "collapseByClick": "collapseByClick"; "snap": "snap"; "enabledBufferOptimization": "enabledBufferOptimization"; "itemRenderer": "itemRenderer"; "itemConfigMap": "itemConfigMap"; "itemSize": "itemSize"; "dynamicSize": "dynamicSize"; "direction": "direction"; "collectionMode": "collectionMode"; "bufferSize": "bufferSize"; "maxBufferSize": "maxBufferSize"; "snappingMethod": "snappingMethod"; "methodForSelecting": "methodForSelecting"; "trackBy": "trackBy"; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; "onViewportChange": "onViewportChange"; "onItemClick": "onItemClick"; "onSelect": "onSelect"; "onCollapse": "onCollapse"; "onScrollReachStart": "onScrollReachStart"; "onScrollReachEnd": "onScrollReachEnd"; }, never, never, false>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NgVirtualListComponent, "ng-virtual-list", never, { "items": "items"; "selectedIds": "selectedIds"; "collapsedIds": "collapsedIds"; "selectByClick": "selectByClick"; "collapseByClick": "collapseByClick"; "snap": "snap"; "enabledBufferOptimization": "enabledBufferOptimization"; "itemRenderer": "itemRenderer"; "itemConfigMap": "itemConfigMap"; "itemSize": "itemSize"; "dynamicSize": "dynamicSize"; "direction": "direction"; "collectionMode": "collectionMode"; "bufferSize": "bufferSize"; "maxBufferSize": "maxBufferSize"; "snappingMethod": "snappingMethod"; "methodForSelecting": "methodForSelecting"; "trackBy": "trackBy"; "screenReaderMessage": "screenReaderMessage"; }, { "onScroll": "onScroll"; "onScrollEnd": "onScrollEnd"; "onViewportChange": "onViewportChange"; "onItemClick": "onItemClick"; "onSelect": "onSelect"; "onCollapse": "onCollapse"; "onScrollReachStart": "onScrollReachStart"; "onScrollReachEnd": "onScrollReachEnd"; }, never, never, false>;
 }

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

@@ -1,9 +1,9 @@
 import { Subject } from 'rxjs';
 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 {
     protected _$unsubscribe: Subject<void>;
@@ -24,7 +24,11 @@ export declare class NgVirtualListService {
     selectByClick: boolean;
     collapseByClick: boolean;
     listElement: HTMLDivElement | null;
-    collection: IRenderVirtualListCollection;
+    private _$displayItems;
+    readonly $displayItems: import("rxjs").Observable<IRenderVirtualListCollection>;
+    private _collection;
+    set collection(v: IRenderVirtualListCollection);
+    get collection(): IRenderVirtualListCollection;
     constructor();
     setSelectedIds(ids: Array<Id> | Id | undefined): void;
     setCollapsedIds(ids: Array<Id>): void;
@@ -43,8 +47,8 @@ export declare class NgVirtualListService {
       */
     collapse(data: IRenderVirtualListItem | undefined, collapsed?: boolean | undefined): void;
     initialize(trackBox: TrackBox): 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;
     generateComponentId(): number;
     destroy(): void;

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/14.x/projects/ng-virtual-list/src/lib/types/focus-alignment.ts
+ * @author Evgenii Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare 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/package.json

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