feat: export cancelScroll handle

inokawa · Jan 5, 2025 · 32bfc46 · 32bfc46
1 parent 7539c2a
commit 32bfc46
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/src/core/scroller.ts b/src/core/scroller.ts
@@ -186,6 +186,7 @@ export type Scroller = {
   $scrollBy: (offset: number) => void;
   $scrollToIndex: (index: number, opts?: ScrollToIndexOpts) => void;
   $fixScrollJump: () => void;
+  $cancelScroll: () => void;
 };
 
 /**
@@ -369,6 +370,9 @@ export const createScroller = (
     $fixScrollJump: () => {
       scrollObserver && scrollObserver._fixScrollJump();
     },
+    $cancelScroll: () => {
+      cancelScroll && cancelScroll();
+    },
   };
 };
 
@@ -581,11 +585,11 @@ export const createWindowScroller = (
           store.$getItemOffset(index) +
           (align === "end"
             ? store.$getItemSize(index) -
-              (store.$getViewportSize() - getScrollbarSize())
+            (store.$getViewportSize() - getScrollbarSize())
             : align === "center"
               ? (store.$getItemSize(index) -
-                  (store.$getViewportSize() - getScrollbarSize())) /
-                2
+                (store.$getViewportSize() - getScrollbarSize())) /
+              2
               : 0)
         );
       }, smooth);

diff --git a/src/react/Virtualizer.tsx b/src/react/Virtualizer.tsx
@@ -86,6 +86,10 @@ export interface VirtualizerHandle {
    * @param offset offset from current position
    */
   scrollBy(offset: number): void;
+  /**
+   * Cancel unfinished scroll.
+   */
+  cancelScroll(): void;
 }
 
 /**
@@ -321,6 +325,7 @@ export const Virtualizer = forwardRef<VirtualizerHandle, VirtualizerProps>(
         scrollToIndex: scroller.$scrollToIndex,
         scrollTo: scroller.$scrollTo,
         scrollBy: scroller.$scrollBy,
+        cancelScroll: scroller.$cancelScroll,
       };
     }, []);