virtua 0.43.5 → 0.44.0

package/lib/solid/index.jsx

@@ -28,12 +28,10 @@ const microtask = typeof queueMicrotask === "function"
  */
 const createPromise = () => {
     let resolve;
-    let reject;
-    const promise = new Promise((res, rej) => {
+    const promise = new Promise((res) => {
         resolve = res;
-        reject = rej;
     });
-    return [promise, resolve, reject];
+    return [promise, resolve];
 };
 /**
  * @internal
@@ -335,8 +333,12 @@ const createVirtualStore = (elementsCount, itemSize = 40, overscan = 4, ssrCount
     };
     const applyJump = (j) => {
         if (j) {
+            if (
             // In iOS WebKit browsers, updating scroll position will stop scrolling so it have to be deferred during scrolling.
-            if (isIOSWebKit() && _scrollDirection !== SCROLL_IDLE) {
+            (isIOSWebKit() && _scrollDirection !== SCROLL_IDLE) ||
+                // Before imperative smooth scrolling, we measure all items which may be visible during scrolling.
+                // However, especially in Firefox, there are rare cases where items resize while scrolling, which can stop smooth scrolling.
+                (_frozenRange && _scrollMode === SCROLL_BY_MANUAL_SCROLL)) {
                 pendingJump += j;
             }
             else {
@@ -375,13 +377,6 @@ const createVirtualStore = (elementsCount, itemSize = 40, overscan = 4, ssrCount
         $findStartIndex: () => findIndex(cache, getVisibleOffset()),
         $findEndIndex: () => findIndex(cache, getVisibleOffset() + viewportSize),
         $isUnmeasuredItem: (index) => cache._sizes[index] === UNCACHED,
-        _hasUnmeasuredItemsInFrozenRange: () => {
-            if (!_frozenRange)
-                return false;
-            return cache._sizes
-                .slice(max(0, _frozenRange[0] - 1), min(cache._length - 1, _frozenRange[1] + 1) + 1)
-                .includes(UNCACHED);
-        },
         $getItemOffset: getItemOffset,
         $getItemSize: getItemSize$1,
         $getItemsLength: () => cache._length,
@@ -393,13 +388,7 @@ const createVirtualStore = (elementsCount, itemSize = 40, overscan = 4, ssrCount
         _flushJump: () => {
             _flushedJump = jump;
             jump = 0;
-            return [
-                _flushedJump,
-                // Use absolute position not to exceed scrollable bounds
-                _scrollMode === SCROLL_BY_SHIFT ||
-                    // https://github.com/inokawa/virtua/discussions/475
-                    getRelativeScrollOffset() + viewportSize >= getTotalSize(),
-            ];
+            return [_flushedJump, _scrollMode === SCROLL_BY_SHIFT];
         },
         $subscribe: (target, cb) => {
             const sub = [target, cb];
@@ -478,10 +467,10 @@ const createVirtualStore = (elementsCount, itemSize = 40, overscan = 4, ssrCount
                         if (
                         // Keep distance from end during shifting
                         _scrollMode === SCROLL_BY_SHIFT ||
-                            (_frozenRange
+                            (_frozenRange && _scrollMode === SCROLL_BY_MANUAL_SCROLL
                                 ? // https://github.com/inokawa/virtua/issues/380
-                                    // https://github.com/inokawa/virtua/issues/590
-                                    !isSSR && index < _frozenRange[0]
+                                    // https://github.com/inokawa/virtua/issues/758
+                                    index < _frozenRange[0]
                                 : // Otherwise we should maintain visible position
                                     getItemOffset(index) +
                                         // https://github.com/inokawa/virtua/issues/385
@@ -704,7 +693,7 @@ const createScroller = (store, isHorizontal) => {
     let viewportElement;
     let scrollObserver;
     let cancelScroll;
-    const [initialized, resolveInitialized] = createPromise();
+    let initialized = createPromise();
     const scrollOffsetKey = isHorizontal ? "scrollLeft" : "scrollTop";
     const overflowKey = isHorizontal ? "overflowX" : "overflowY";
     // The given offset will be clamped by browser
@@ -713,8 +702,7 @@ const createScroller = (store, isHorizontal) => {
         // Wait for element assign. The element may be undefined if scrollRef prop is used and scroll is scheduled on mount.
         // https://github.com/inokawa/virtua/pull/733
         // https://github.com/inokawa/virtua/pull/750
-        const ok = await initialized;
-        if (!ok) {
+        if (!(await initialized[0])) {
             return;
         }
         if (cancelScroll) {
@@ -743,33 +731,44 @@ const createScroller = (store, isHorizontal) => {
             ];
         };
         if (smooth && isSmoothScrollSupported()) {
-            while (true) {
-                store.$update(ACTION_BEFORE_MANUAL_SMOOTH_SCROLL, getTargetOffset());
-                if (!store._hasUnmeasuredItemsInFrozenRange()) {
-                    break;
-                }
-                const [promise, unsubscribe] = waitForMeasurement();
-                try {
-                    if (!(await promise)) {
-                        // canceled
-                        return;
+            store.$update(ACTION_BEFORE_MANUAL_SMOOTH_SCROLL, getTargetOffset());
+            // https://github.com/inokawa/virtua/issues/590
+            microtask(async () => {
+                while (true) {
+                    let measuring = false;
+                    for (let [i, end] = store.$getRange(); i <= end; i++) {
+                        if (store.$isUnmeasuredItem(i)) {
+                            measuring = true;
+                            break;
+                        }
+                    }
+                    if (!measuring) {
+                        break;
+                    }
+                    const [promise, unsubscribe] = waitForMeasurement();
+                    try {
+                        if (!(await promise)) {
+                            // canceled
+                            return;
+                        }
+                    }
+                    finally {
+                        unsubscribe();
                     }
                 }
-                finally {
-                    unsubscribe();
-                }
-            }
-            viewportElement.scrollTo({
-                [isHorizontal ? "left" : "top"]: normalizeOffset(getTargetOffset(), isHorizontal),
-                behavior: "smooth",
+                store.$update(ACTION_MANUAL_SCROLL);
+                viewportElement.scrollTo({
+                    [isHorizontal ? "left" : "top"]: normalizeOffset(getTargetOffset(), isHorizontal),
+                    behavior: "smooth",
+                });
             });
         }
         else {
             while (true) {
                 const [promise, unsubscribe] = waitForMeasurement();
                 try {
-                    viewportElement[scrollOffsetKey] = normalizeOffset(getTargetOffset(), isHorizontal);
                     store.$update(ACTION_MANUAL_SCROLL);
+                    viewportElement[scrollOffsetKey] = normalizeOffset(getTargetOffset(), isHorizontal);
                     if (!(await promise)) {
                         // canceled or finished
                         return;
@@ -797,20 +796,21 @@ const createScroller = (store, isHorizontal) => {
                         style[overflowKey] = prev;
                     });
                 }
+                // Use absolute position not to exceed scrollable bounds
+                // https://github.com/inokawa/virtua/discussions/475
+                viewport[scrollOffsetKey] = store.$getScrollOffset() + jump;
                 if (shift) {
-                    viewport[scrollOffsetKey] = store.$getScrollOffset() + jump;
                     // https://github.com/inokawa/virtua/issues/357
                     cancelScroll && cancelScroll();
                 }
-                else {
-                    viewport[scrollOffsetKey] += jump;
-                }
             });
-            resolveInitialized(true);
+            initialized[1](true);
         },
         $dispose() {
             scrollObserver && scrollObserver._dispose();
-            resolveInitialized(false);
+            initialized[1](false);
+            // https://github.com/inokawa/virtua/pull/765
+            initialized = createPromise();
         },
         $scrollTo(offset) {
             scheduleImperativeScroll(() => offset);
@@ -859,7 +859,7 @@ const createWindowScroller = (store, isHorizontal) => {
     let containerElement;
     let scrollObserver;
     let cancelScroll;
-    const [initialized, resolveInitialized] = createPromise();
+    let initialized = createPromise();
     const calcOffsetToViewport = (node, viewport, window, isHorizontal, offset = 0) => {
         // TODO calc offset only when it changes (maybe impossible)
         const offsetKey = isHorizontal ? "offsetLeft" : "offsetTop";
@@ -877,8 +877,7 @@ const createWindowScroller = (store, isHorizontal) => {
         // Wait for element assign. The element may be undefined if scrollRef prop is used and scroll is scheduled on mount.
         // https://github.com/inokawa/virtua/pull/733
         // https://github.com/inokawa/virtua/pull/750
-        const ok = await initialized;
-        if (!ok) {
+        if (!(await initialized[0])) {
             return;
         }
         if (cancelScroll) {
@@ -907,34 +906,46 @@ const createWindowScroller = (store, isHorizontal) => {
         };
         const window = getCurrentWindow(getCurrentDocument(containerElement));
         if (smooth && isSmoothScrollSupported()) {
-            while (true) {
-                store.$update(ACTION_BEFORE_MANUAL_SMOOTH_SCROLL, getTargetOffset());
-                if (!store._hasUnmeasuredItemsInFrozenRange()) {
-                    break;
-                }
-                const [promise, unsubscribe] = waitForMeasurement();
-                try {
-                    if (!(await promise)) {
-                        return;
+            store.$update(ACTION_BEFORE_MANUAL_SMOOTH_SCROLL, getTargetOffset());
+            // https://github.com/inokawa/virtua/issues/590
+            microtask(async () => {
+                while (true) {
+                    let measuring = false;
+                    for (let [i, end] = store.$getRange(); i <= end; i++) {
+                        if (store.$isUnmeasuredItem(i)) {
+                            measuring = true;
+                            break;
+                        }
+                    }
+                    if (!measuring) {
+                        break;
+                    }
+                    const [promise, unsubscribe] = waitForMeasurement();
+                    try {
+                        if (!(await promise)) {
+                            // canceled
+                            return;
+                        }
+                    }
+                    finally {
+                        unsubscribe();
                     }
                 }
-                finally {
-                    unsubscribe();
-                }
-            }
-            window.scroll({
-                [isHorizontal ? "left" : "top"]: normalizeOffset(getTargetOffset(), isHorizontal),
-                behavior: "smooth",
+                store.$update(ACTION_MANUAL_SCROLL);
+                window.scroll({
+                    [isHorizontal ? "left" : "top"]: normalizeOffset(getTargetOffset(), isHorizontal),
+                    behavior: "smooth",
+                });
             });
         }
         else {
             while (true) {
                 const [promise, unsubscribe] = waitForMeasurement();
                 try {
+                    store.$update(ACTION_MANUAL_SCROLL);
                     window.scroll({
                         [isHorizontal ? "left" : "top"]: normalizeOffset(getTargetOffset(), isHorizontal),
                     });
-                    store.$update(ACTION_MANUAL_SCROLL);
                     if (!(await promise)) {
                         return;
                     }
@@ -952,23 +963,22 @@ const createWindowScroller = (store, isHorizontal) => {
             const document = getCurrentDocument(container);
             const window = getCurrentWindow(document);
             const documentBody = document.body;
-            scrollObserver = createScrollObserver(store, window, isHorizontal, () => normalizeOffset(window[scrollOffsetKey], isHorizontal), (jump, shift) => {
+            scrollObserver = createScrollObserver(store, window, isHorizontal, () => normalizeOffset(window[scrollOffsetKey], isHorizontal), (jump) => {
+                // Use absolute position not to exceed scrollable bounds
+                // https://github.com/inokawa/virtua/discussions/475
                 // TODO support case two window scrollers exist in the same view
-                if (shift) {
-                    window.scroll({
-                        [isHorizontal ? "left" : "top"]: store.$getScrollOffset() + jump,
-                    });
-                }
-                else {
-                    window.scrollBy(isHorizontal ? jump : 0, isHorizontal ? 0 : jump);
-                }
+                window.scroll({
+                    [isHorizontal ? "left" : "top"]: store.$getScrollOffset() + jump,
+                });
             }, () => calcOffsetToViewport(container, documentBody, window, isHorizontal));
-            resolveInitialized(true);
+            initialized[1](true);
         },
         $dispose() {
             scrollObserver && scrollObserver._dispose();
             containerElement = undefined;
-            resolveInitialized(false);
+            initialized[1](false);
+            // https://github.com/inokawa/virtua/pull/765
+            initialized = createPromise();
         },
         $fixScrollJump: () => {
             scrollObserver && scrollObserver._fixScrollJump();