docs: update scrollToFn/Offset/Index/ options (#720)

TanStack · May 6, 2024 · d192756 · d192756
1 parent 072205b
commit d192756
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/api/virtualizer.md b/docs/api/virtualizer.md
@@ -141,7 +141,7 @@ This function receives visible range indexes and should return array of indexes
 ```tsx
 scrollToFn?: (
   offset: number,
-  canSmooth: boolean,
+  options: { adjustments?: number; behavior?: 'auto' | 'smooth' },
   instance: Virtualizer<TScrollElement, TItemElement>,
 ) => void
 ```
@@ -254,7 +254,7 @@ scrollToOffset: (
   toOffset: number,
   options?: {
     align?: 'start' | 'center' | 'end' | 'auto',
-    smoothScroll?: boolean
+    behavior?: 'auto' | 'smooth'
   }
 ) => void
 ```
@@ -268,7 +268,7 @@ scrollToIndex: (
   index: number,
   options?: {
     align?: 'start' | 'center' | 'end' | 'auto',
-    smoothScroll?: boolean
+    behavior?: 'auto' | 'scroll'
   }
 ) => void
 ```