fix(react-virtual): window virtualizer scroll persistence #1044
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎯 Changes
Fix scroll position persistence in useWindowVirtualizer when navigating between routes
This PR removes the automatic initialOffset: () => window.scrollY from useWindowVirtualizer that was causing
scroll position to persist incorrectly when navigating between routes in single-page applications.
The Problem
When using useWindowVirtualizer in a SPA with client-side routing:
Open issues:
#997
TanStack/router#4107
The Solution
Tests Added
This change aligns with the API documentation which states that initialOffset is "usually only useful if you are
rendering the virtualizer in a SSR environment."
✅ Checklist
or this PR should not release a new version.