useWindowVirtualizer with measureElement breaks scroll restoration
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- react, typescript
- Domain
- frontend, performance
Research direction
Run the CodeSandbox reproduction and compare navigation with and without the commented scrollToFn option. Trace the interaction between useWindowVirtualizer, measureElement, re-measurement, and scroll restoration during the listed navigation steps; done means the list returns to the top without requiring the workaround.
Written by the indexing model from the issue text.
Description
Describe the bug
When using
"@tanstack/react-virtual": "3.13.8"
and
"@tanstack/react-router": "1.112.12"
If the page contains a virtualized list like this:
const virtualizer = useWindowVirtualizer({
gap: 16,
overscan: 4,
count: data.items.length,
estimateSize: constant(188),
scrollMargin: listRef.current?.offsetTop ?? 0,
});
And the items use:
ref={virtualizer.measureElement}
data-index={index}
But the actual element sizes differ from estimateSize, triggering re-measurement on mount — in that case, scrollRestoration breaks.
This might be an issue on the @tanstack/react-router side; I’ll duplicate this issue there as well.
Current workaround: add this option to the virtualizer:
scrollToFn: () => null,
Your minimal, reproducible example
https://codesandbox.io/p/sandbox/2lryyk
Steps to reproduce
1 Open the Home page
2 Scroll down a bit
3 Navigate to the List page
4 You'll notice that the page is not scrolled to the top
In the code, there's a commented line:
in code there are commented string with
scrollToFn: () => null
Uncommenting this line.
After doing that, navigation with scroll restoration works perfectly.
Expected behavior
Virtualizer does not break scroll restoration.
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
maxOS
tanstack-virtual version
3.13.8
TypeScript version
5.7.3
Additional context
No response
Terms & Code of Conduct
- I agree to follow this project's Code of Conduct
- I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 495
- Avg merge
- 23h 16m
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/virtual
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
With `useScrollendEvent`, scrollToIndex and scrollToEnd stop short when the target moves while they settlePossibly taken @Darkatse claimed this 8 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribesPossibly taken @clean99 claimed this 13 days ago. Open
Difficulty 4/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' does not keep the reading position when only paddingStart changesPossibly taken @duongynhi000001-crypto claimed this 12 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
anchorTo: 'end' loses the end when the scroll element shrinksPossibly taken @langleyd claimed this 41 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Maintainers usually reply within 1 day
All issues in TanStack/virtual
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
gofish-graphics/gofish-graphics#1384 ·
Maintainers usually reply within 1 day
-
adapter bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Olanetsoft/agent-lookout#353 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
vicharanashala/vibe#1542 ·
Maintainers usually reply within 1 day
-
bug chore P2 size:XS
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
josephfung/curia#2666 ·
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
devarshishimpi/codra#178 ·
Maintainers usually reply within 1 day