ng-virtual-list 20.9.4 → 20.9.6

package/README.md

@@ -700,6 +700,10 @@ Methods
 | scrollToEnd | (cb?: () => void, options?: [IScrollOptions](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/models/scroll-options.model.ts)) | Scrolls the scroll area to the last item in the collection. |
 | getItemBounds | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/types/id.ts), behavior?: ScrollBehavior) => void | Returns the bounds of an element with a given id |
 | focus | [Id](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/types/id.ts), align: [FocusAlignment](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/types/focus-alignment.ts) = [FocusAlignments.NONE](https://github.com/DjonnyX/ng-virtual-list/blob/20.x/projects/ng-virtual-list/src/lib/enums/focus-alignments.ts) | Focus an list item by a given id. |
+| cacheClean |  | Force clearing the cache. |
+| stopSnappingScrollToEnd |  | Stops the list from snapping to the bottom edge. |
+| updateImmediately |  | Instantly refreshes the list. |
+| markForUpdate |  | Marks the list for an update that will trigger on the next tick. |
 
 <br/>
 

package/fesm2022/ng-virtual-list.mjs

@@ -345,8 +345,8 @@ class NgVirtualListService {
             this.select(data);
         }
     }
-    update() {
-        this._trackBox?.changes();
+    update(immediately = false) {
+        this._trackBox?.changes(immediately);
     }
     /**
      * Selects a list item
@@ -2186,8 +2186,15 @@ class TrackBox extends CacheMap {
             this.clearScrollDirectionCache();
         }
     }
-    changes() {
+    changes(immediately = false) {
+        if (this.changesDetected()) {
+            return;
+        }
         this.bumpVersion();
+        if (immediately) {
+            this._previousVersion = this._version;
+            this.dispatch(CACHE_BOX_CHANGE_EVENT_NAME, this.version);
+        }
     }
     generateDisplayCollection(items, itemConfigMap, metrics) {
         const { offsetY, offsetX, width, height, normalizedItemWidth, normalizedItemHeight, dynamicSize, itemsOnDisplayLength, itemsFromStartToScrollEnd, isVertical, renderItems: renderItemsLength, scrollSize, sizeProperty, snap, snippedPos, startPosition, totalLength, startIndex, typicalItemSize, } = metrics, displayItems = [];
@@ -4533,20 +4540,24 @@ class NgVirtualListComponent {
                         scrollerComponent.prepared = true;
                     }
                     this.classes.set({ prepared: true, [READY_TO_START]: true, [WAIT_FOR_PREPARATION]: waitForPreparation });
+                    this.updateImmediately();
                 }
             }
         }), filter$1(v => !!v), delay(0), takeUntilDestroyed(this._destroyRef), tap(v => {
             prepared = v;
+            this.updateImmediately();
         }), delay(0), takeUntilDestroyed(this._destroyRef), tap(v => {
             const waitForPreparation = this.waitForPreparation(), scrollerComponent = this._scrollerComponent(), val = v || !waitForPreparation;
             if (scrollerComponent) {
                 scrollerComponent.prepared = val;
             }
             this.classes.set({ prepared: val, [WAIT_FOR_PREPARATION]: waitForPreparation });
+            this.updateImmediately();
         }), delay(1000), takeUntilDestroyed(this._destroyRef), tap(v => {
             const waitForPreparation = this.waitForPreparation();
             readyToStart = v;
             this.classes.set({ prepared: true, [READY_TO_START]: true, [WAIT_FOR_PREPARATION]: waitForPreparation });
+            this.updateImmediately();
         })).subscribe();
         this._service.$focusedId.pipe(takeUntilDestroyed(), tap(v => {
             this.focusedElement.set(v ?? undefined);
@@ -4909,8 +4920,7 @@ class NgVirtualListComponent {
                             snap: this.snap(), fromItemId: id, enabledBufferOptimization: this.enabledBufferOptimization(),
                         }, scrollSize = this._trackBox.getItemPosition(id, itemConfigMap, opts), params = {
                             [isVertical ? TOP_PROP_NAME : LEFT_PROP_NAME]: scrollSize, behavior: BEHAVIOR_INSTANT,
-                            fireUpdate: false,
-                            blending: true,
+                            fireUpdate: false, blending: false,
                         };
                         if (scrollSize === -1) {
                             return of([true, { id, scroller: scrollerComponent, scrollCalled, cb }]);
@@ -4953,7 +4963,7 @@ class NgVirtualListComponent {
                                 _$scrollToEndDuringUpdateCanceller.next(1);
                                 const params = {
                                     [this._isVertical ? TOP_PROP_NAME : LEFT_PROP_NAME]: scrollSize,
-                                    behavior: BEHAVIOR_INSTANT, blending: true,
+                                    behavior: BEHAVIOR_INSTANT, blending: false,
                                 };
                                 scrollerComponent?.scrollTo?.(params);
                                 return of([true, { id, scroller: scrollerComponent, cb }]).pipe(delay(1));
@@ -5193,6 +5203,9 @@ class NgVirtualListComponent {
             this._trackBox.changes();
         }
     }
+    /**
+     * Force clearing the cache.
+     */
     cacheClean() {
         this._trackBox.cacheClean();
         this._collapsedItemIds.set([]);
@@ -5206,6 +5219,9 @@ class NgVirtualListComponent {
         }
         this._$prepared.next(false);
     }
+    /**
+     * Stops the list from snapping to the bottom edge.
+     */
     stopSnappingScrollToEnd() {
         const scroller = this._scrollerComponent();
         this._isScrollFinished.set(false);
@@ -5214,6 +5230,18 @@ class NgVirtualListComponent {
             scroller.stopScrolling();
         }
     }
+    /**
+     * Instantly refreshes the list.
+     */
+    updateImmediately() {
+        this._service.update(true);
+    }
+    /**
+     * Marks the list for an update that will trigger on the next tick.
+     */
+    markForUpdate() {
+        this._service.update();
+    }
     ngOnDestroy() {
         this.dispose();
     }