Merge pull request #389 from inokawa/hangle-get-item-offset

Add getItemOffset to VirtualizerHandle
inokawa · Feb 21, 2024 · 2a92d85 · 2a92d85
2 parents 0297ca5 + 833665e
commit 2a92d85
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/src/react/Virtualizer.tsx b/src/react/Virtualizer.tsx
@@ -52,6 +52,11 @@ export interface VirtualizerHandle {
    * Get current offsetHeight or offsetWidth.
    */
   readonly viewportSize: number;
+  /**
+   * Get item offset from start.
+   * @param index index of item
+   */
+  getItemOffset(index: number): number;
   /**
    * Scroll to the item specified by index.
    * @param index index of item
@@ -296,6 +301,7 @@ export const Virtualizer = forwardRef<VirtualizerHandle, VirtualizerProps>(
           get viewportSize() {
             return store._getViewportSize();
           },
+          getItemOffset: store._getItemOffset,
           scrollToIndex: scroller._scrollToIndex,
           scrollTo: scroller._scrollTo,
           scrollBy: scroller._scrollBy,

diff --git a/src/solid/Virtualizer.tsx b/src/solid/Virtualizer.tsx
@@ -46,6 +46,11 @@ export interface VirtualizerHandle {
    * Get current offsetHeight or offsetWidth.
    */
   readonly viewportSize: number;
+  /**
+   * Get item offset from start.
+   * @param index index of item
+   */
+  getItemOffset(index: number): number;
   /**
    * Scroll to the item specified by index.
    * @param index index of item
@@ -215,6 +220,7 @@ export const Virtualizer = <T,>(props: VirtualizerProps<T>): JSX.Element => {
         get viewportSize() {
           return store._getViewportSize();
         },
+        getItemOffset: store._getItemOffset,
         scrollToIndex: scroller._scrollToIndex,
         scrollTo: scroller._scrollTo,
         scrollBy: scroller._scrollBy,

diff --git a/src/vue/VList.tsx b/src/vue/VList.tsx
@@ -66,6 +66,7 @@ export const VList = /*#__PURE__*/ defineComponent({
       get viewportSize() {
         return handle.value!.viewportSize;
       },
+      getItemOffset: (...args) => handle.value!.getItemOffset(...args),
       scrollToIndex: (...args) => handle.value!.scrollToIndex(...args),
       scrollTo: (...args) => handle.value!.scrollTo(...args),
       scrollBy: (...args) => handle.value!.scrollBy(...args),

diff --git a/src/vue/Virtualizer.tsx b/src/vue/Virtualizer.tsx
@@ -41,6 +41,11 @@ export interface VirtualizerHandle {
    * Get current offsetHeight or offsetWidth.
    */
   readonly viewportSize: number;
+  /**
+   * Get item offset from start.
+   * @param index index of item
+   */
+  getItemOffset(index: number): number;
   /**
    * Scroll to the item specified by index.
    * @param index index of item
@@ -171,6 +176,7 @@ export const Virtualizer = /*#__PURE__*/ defineComponent({
       get viewportSize() {
         return store._getViewportSize();
       },
+      getItemOffset: store._getItemOffset,
       scrollToIndex: scroller._scrollToIndex,
       scrollTo: scroller._scrollTo,
       scrollBy: scroller._scrollBy,