fix: initialOffset forces layout in window virtualizer (#705)

TanStack · Apr 11, 2024 · 44fb184 · 44fb184
1 parent 3bf3ae1
commit 44fb184
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 9 deletions.
diff --git a/docs/api/virtualizer.md b/docs/api/virtualizer.md
@@ -115,7 +115,7 @@ The padding to apply to the end of the virtualizer in pixels when scrolling to a
 ### `initialOffset`
 
 ```tsx
-initialOffset?: number
+initialOffset?: number | (() => number)
 ```
 
 The initial offset to apply to the virtualizer. This is usually only useful if you are rendering the virtualizer in a SSR environment.

diff --git a/packages/react-virtual/src/index.tsx b/packages/react-virtual/src/index.tsx
@@ -86,7 +86,7 @@ export function useWindowVirtualizer<TItemElement extends Element>(
     observeElementRect: observeWindowRect,
     observeElementOffset: observeWindowOffset,
     scrollToFn: windowScroll,
-    initialOffset: typeof document !== 'undefined' ? window.scrollY : undefined,
+    initialOffset: () => (typeof document !== 'undefined' ? window.scrollY : 0),
     ...options,
   })
 }
diff --git a/packages/solid-virtual/src/index.tsx b/packages/solid-virtual/src/index.tsx
@@ -125,8 +125,8 @@ export function createWindowVirtualizer<TItemElement extends Element>(
         observeElementRect: observeWindowRect,
         observeElementOffset: observeWindowOffset,
         scrollToFn: windowScroll,
-        initialOffset:
-          typeof document !== 'undefined' ? window.scrollY : undefined,
+        initialOffset: () =>
+          typeof document !== 'undefined' ? window.scrollY : 0,
       },
       options,
     ),

diff --git a/packages/svelte-virtual/src/index.ts b/packages/svelte-virtual/src/index.ts
@@ -95,7 +95,7 @@ export function createWindowVirtualizer<TItemElement extends Element>(
     observeElementRect: observeWindowRect,
     observeElementOffset: observeWindowOffset,
     scrollToFn: windowScroll,
-    initialOffset: typeof document !== 'undefined' ? window.scrollY : undefined,
+    initialOffset: () => (typeof document !== 'undefined' ? window.scrollY : 0),
     ...options,
   })
 }
diff --git a/packages/virtual-core/src/index.ts b/packages/virtual-core/src/index.ts
@@ -262,7 +262,7 @@ export interface VirtualizerOptions<
   paddingEnd?: number
   scrollPaddingStart?: number
   scrollPaddingEnd?: number
-  initialOffset?: number
+  initialOffset?: number | (() => number)
   getItemKey?: (index: number) => Key
   rangeExtractor?: (range: Range) => number[]
   scrollMargin?: number
@@ -320,7 +320,10 @@ export class Virtualizer<
   constructor(opts: VirtualizerOptions<TScrollElement, TItemElement>) {
     this.setOptions(opts)
     this.scrollRect = this.options.initialRect
-    this.scrollOffset = this.options.initialOffset
+    this.scrollOffset =
+      typeof this.options.initialOffset === 'function'
+        ? this.options.initialOffset()
+        : this.options.initialOffset
     this.measurementsCache = this.options.initialMeasurementsCache
     this.measurementsCache.forEach((item) => {
       this.itemSizeCache.set(item.key, item.size)

diff --git a/packages/vue-virtual/src/index.ts b/packages/vue-virtual/src/index.ts
@@ -107,8 +107,8 @@ export function useWindowVirtualizer<TItemElement extends Element>(
       observeElementRect: observeWindowRect,
       observeElementOffset: observeWindowOffset,
       scrollToFn: windowScroll,
-      initialOffset:
-        typeof document !== 'undefined' ? window.scrollY : undefined,
+      initialOffset: () =>
+        typeof document !== 'undefined' ? window.scrollY : 0,
       ...unref(options),
     })),
   )