ng-virtual-list 20.11.8 → 20.11.9

package/README.md

@@ -638,7 +638,7 @@ Inputs
 | scrollbarThumbRenderer | TemplateRef<any> \| null = null | Scrollbar customization template. |
 | scrollbarThumbParams | {[propName: string]: any;} \| null | Additional options for the scrollbar. |
 | scrollBehavior | ScrollBehavior? = 'smooth' | Defines the scrolling behavior for any element on the page. The default value is "smooth". |
-| scrollingSettings | [IScrollingSettings](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/interfaces/scrolling-settings.ts) = {frictionalForce: 0.035, mass: 0.005, maxDistance: 12500, maxDuration: 4000, speedScale: 15} | Scrolling settings. |
+| scrollingSettings | [IScrollingSettings](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/interfaces/scrolling-settings.ts) = {frictionalForce: 0.035, mass: 0.005, maxDistance: 12500, maxDuration: 4000, speedScale: 15, optimization: true} | Scrolling settings. |
 | trackBy | string? = 'id' | The name of the property by which tracking is performed. |
 
 <br/>

package/fesm2022/ng-virtual-list.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Injectable, inject, signal, ElementRef, DestroyRef, computed, output, Input, Directive, Injector, ChangeDetectionStrategy, Component, InjectionToken, viewChild, input, ViewChild, effect, ViewContainerRef, ViewEncapsulation, NO_ERRORS_SCHEMA, NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
+import { Injectable, inject, signal, ElementRef, DestroyRef, computed, output, Input, Directive, Injector, ChangeDetectionStrategy, Component, InjectionToken, viewChild, input, ViewChild, effect, ViewContainerRef, ViewEncapsulation, NO_ERRORS_SCHEMA, NgModule } from '@angular/core';
 import { Subject, BehaviorSubject, tap, fromEvent, race, of, debounceTime, switchMap as switchMap$1, combineLatest, map, filter as filter$1, takeUntil as takeUntil$1, startWith, from, take, delay, distinctUntilChanged, skip } from 'rxjs';
 import { takeUntilDestroyed, toObservable } from '@angular/core/rxjs-interop';
 import { BehaviorSubject as BehaviorSubject$1 } from 'rxjs/internal/BehaviorSubject';
@@ -196,6 +196,7 @@ const DEFAULT_SCROLLING_SETTINGS = {
     mass: 0.005,
     maxDistance: 12500,
     speedScale: 15,
+    optimization: true,
 };
 const DEFAULT_OVERSCROLL_ENABLED = true;
 const DEFAULT_SNAP = false;
@@ -2479,6 +2480,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
  */
 class BaseVirtualListItemComponent {
     _apiService = inject(NgVirtualListPublicService);
+    _service = inject(NgVirtualListService);
     _id;
     get id() {
         return this._id;
@@ -2544,6 +2546,9 @@ class BaseVirtualListItemComponent {
     }
     _destroyRef = inject(DestroyRef);
     constructor() {
+        this._id = this._service.generateComponentId();
+        this._listId = this._service.id;
+        this._displayId = createDisplayId(this._listId, this._id);
         this.classes = computed(() => {
             const data = this.data(), focused = this.focused();
             return {
@@ -2725,14 +2730,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
  * @email djonnyx@gmail.com
  */
 class NgVirtualListItemComponent extends BaseVirtualListItemComponent {
-    _service = inject(NgVirtualListService);
     maxClickDistance = signal(DEFAULT_CLICK_DISTANCE, ...(ngDevMode ? [{ debugName: "maxClickDistance" }] : []));
     _injector = inject(Injector);
     constructor() {
         super();
-        this._id = this._service.generateComponentId();
-        this._listId = this._service.id;
-        this._displayId = createDisplayId(this._listId, this._id);
     }
     ngOnInit() {
         this._service.$clickDistance.pipe(takeUntilDestroyed(this._destroyRef), tap(v => {
@@ -5188,7 +5189,7 @@ class NgVirtualListComponent {
         transform: (v) => {
             let valid = validateObject(v, true, true);
             if (valid && !!v) {
-                const { frictionalForce, mass, maxDistance, maxDuration, speedScale } = v;
+                const { frictionalForce, mass, maxDistance, maxDuration, speedScale, optimization } = v;
                 valid = validateFloat(frictionalForce, true);
                 if (!valid) {
                     console.error('The "frictionalForce" parameter must be of type `number` or `undefined`.');
@@ -5214,6 +5215,11 @@ class NgVirtualListComponent {
                     console.error('The "speedScale" parameter must be of type `number` or `undefined`.');
                     return DEFAULT_SCROLLING_SETTINGS;
                 }
+                valid = validateBoolean(optimization, true);
+                if (!valid) {
+                    console.error('The "optimization" parameter must be of type `boolean` or `undefined`.');
+                    return DEFAULT_SCROLLING_SETTINGS;
+                }
             }
             if (!valid) {
                 console.error('The "scrollingSettings" parameter must be of type `object` or null.');
@@ -5225,6 +5231,7 @@ class NgVirtualListComponent {
                 maxDistance: v.maxDistance !== undefined && v.maxDistance > 0 ? v.maxDistance : DEFAULT_SCROLLING_SETTINGS.maxDistance,
                 maxDuration: v.maxDuration !== undefined && v.maxDuration > 0 ? v.maxDuration : DEFAULT_SCROLLING_SETTINGS.maxDuration,
                 speedScale: v.speedScale !== undefined && v.speedScale > 0 ? v.speedScale : DEFAULT_SCROLLING_SETTINGS.speedScale,
+                optimization: v.optimization ?? DEFAULT_SCROLLING_SETTINGS.optimization,
             };
         },
     };
@@ -5235,6 +5242,7 @@ class NgVirtualListComponent {
      * - maxDistance - Maximum scrolling distance. Default value is 12500.
      * - maxDuration - Maximum animation duration. Default value is 4000.
      * - speedScale - Speed scale. Default value is 15.
+     * - optimization - Enables scrolling performance optimization. Default value is `true`.
      */
     scrollingSettings = input(DEFAULT_SCROLLING_SETTINGS, ...(ngDevMode ? [{ debugName: "scrollingSettings", ...this._scrollingSettingsOptions }] : [{ ...this._scrollingSettingsOptions }]));
     _animationParamsOptions = {
@@ -6254,16 +6262,18 @@ class NgVirtualListComponent {
                     itemsChanged = true;
                     prevItems = items;
                 }
-                const scroller = this._scrollerComponent(), velocity = this._scrollerComponent()?.averageVelocity ?? 0, maxScrollSize = isVertical ? (scroller?.scrollHeight || 0) : (scroller?.scrollWidth ?? 0), isEdges = scrollSize === 0 || scrollSize === maxScrollSize, isScrolling = this._$scrollingTo.getValue(), useDebouncedUpdate = dynamicSize && !itemsChanged && hasUserAction && !isScrolling && (velocity > 0 && velocity < MAX_VELOCITY_FOR_SCROLL_QUALITY_OPTIMIZATION_LVL1), rerenderOptimization = dynamicSize && !itemsChanged && (hasUserAction || hasScrollbarUserAction) && !isEdges && velocity > 0 &&
+                const enabledOptimization = this.scrollingSettings()?.optimization ?? DEFAULT_SCROLLING_SETTINGS.optimization, scroller = this._scrollerComponent(), velocity = this._scrollerComponent()?.averageVelocity ?? 0, maxScrollSize = isVertical ? (scroller?.scrollHeight || 0) : (scroller?.scrollWidth ?? 0), isEdges = scrollSize === 0 || scrollSize === maxScrollSize, isScrolling = this._$scrollingTo.getValue(), useDebouncedUpdate = dynamicSize && !itemsChanged && hasUserAction && !isScrolling && (velocity > 0 && velocity < MAX_VELOCITY_FOR_SCROLL_QUALITY_OPTIMIZATION_LVL1), rerenderOptimization = enabledOptimization && dynamicSize && !itemsChanged && (hasUserAction || hasScrollbarUserAction) && !isEdges && velocity > 0 &&
                     (velocity > MAX_VELOCITY_FOR_SCROLL_QUALITY_OPTIMIZATION_LVL2 || hasUserAction);
-                if (useDebouncedUpdate) {
-                    debouncedUpdate.execute({
-                        snapScrollToStart, snapScrollToEnd, bounds, listBounds, scrollEndOffset, items, itemConfigMap, scrollSize, itemSize, collapsedIds,
-                        bufferSize, maxBufferSize, snap, isVertical, dynamicSize, enabledBufferOptimization, cacheVersion, userAction: hasUserAction,
-                    }, rerenderOptimization, itemsChanged);
-                    return;
+                if (enabledOptimization) {
+                    if (useDebouncedUpdate) {
+                        debouncedUpdate.execute({
+                            snapScrollToStart, snapScrollToEnd, bounds, listBounds, scrollEndOffset, items, itemConfigMap, scrollSize, itemSize, collapsedIds,
+                            bufferSize, maxBufferSize, snap, isVertical, dynamicSize, enabledBufferOptimization, cacheVersion, userAction: hasUserAction,
+                        }, rerenderOptimization, itemsChanged);
+                        return;
+                    }
+                    debouncedUpdate.dispose();
                 }
-                debouncedUpdate.dispose();
                 if (!isScrolling) {
                     update({
                         snapScrollToStart, snapScrollToEnd, bounds, listBounds, scrollEndOffset, items, itemConfigMap, scrollSize, itemSize, collapsedIds,
@@ -6902,7 +6912,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
                     declarations: [NgVirtualListItemComponent],
                     exports: [NgVirtualListItemComponent],
                     imports: [CommonModule, ItemClickModule],
-                    schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA],
+                    schemas: [NO_ERRORS_SCHEMA],
                 }]
         }] });
 
@@ -6917,7 +6927,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
                     declarations: [NgScrollBarComponent],
                     exports: [NgScrollBarComponent],
                     imports: [CommonModule],
-                    schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA],
+                    schemas: [NO_ERRORS_SCHEMA],
                 }]
         }] });
 
@@ -6932,7 +6942,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
                     declarations: [NgScrollerComponent],
                     exports: [NgScrollerComponent],
                     imports: [CommonModule, NgScrollBarModule, LocaleSensitiveModule, CdkScrollableModule],
-                    schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA],
+                    schemas: [NO_ERRORS_SCHEMA],
                 }]
         }] });
 
@@ -6947,7 +6957,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
                     declarations: [NgPrerenderVirtualListItemComponent],
                     exports: [NgPrerenderVirtualListItemComponent],
                     imports: [CommonModule, ItemClickModule],
-                    schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA],
+                    schemas: [NO_ERRORS_SCHEMA],
                 }]
         }] });
 
@@ -6962,7 +6972,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.17", ngImpo
                     declarations: [NgPrerenderScrollerComponent],
                     exports: [NgPrerenderScrollerComponent],
                     imports: [CommonModule, LocaleSensitiveModule],
-                    schemas: [CUSTOM_ELEMENTS_SCHEMA, NO_ERRORS_SCHEMA],
+                    schemas: [NO_ERRORS_SCHEMA],
                 }]
         }] });