Scroll restoration scrolls the window to the top on the first render after SSR hydration
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 3/5
- Temps estimé
- Une demi-journée
- Accessibilité débutants
- 35/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- playwright, react, typescript, vite
- Domaine
- frontend
Piste de recherche
Start from packages/router-core/src/router.ts:1148-1155, where RouterCore._scroll is initialised to { n: true }, then read packages/router-core/src/scroll-restoration.ts:253 and :353-361 to see the onRendered listener acting on that flag and calling scrollTo({ top: 0 }). The hydration path to check is packages/router-core/src/load-client.ts after router.ssr = … (line 2224), with packages/react-router/src/Transitioner.tsx:76-88 showing where onRendered fires on the first render. Done means the reproducer's Playwright test (hold scripts, scroll to 2000, release, wait for onRendered) reports a preserved scrollY in Chromium and WebKit, with later navigations still resetting scroll. Note an open PR (#8934) already proposes this change.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Which project does this relate to?
Router
Describe the bug
With SSR and scrollRestoration: true, the router's first render after hydration scrolls the window to the top. The page is readable and scrollable before the client bundle hydrates it, so a visitor who scrolls during that time is thrown back to the top once the app hydrates.
Complete minimal reproducer
https://github.com/pjborowiecki/tanstack-router-hydration-scroll-repro (StackBlitz: https://stackblitz.com/github/pjborowiecki/tanstack-router-hydration-scroll-repro)
Steps to Reproduce the Bug
npm install && npx playwright install chromium webkit && npx playwright test- The test holds the client scripts, scrolls the server-rendered page to 2000px, releases the scripts and waits for the router's first
onRendered. window.scrollYis0. Fails on every run in Chromium and WebKit.
By hand: npm run build && npm run preview, throttle the network in DevTools so the scripts load slowly, scroll down as soon as the page appears, and the page jumps to the top when it hydrates.
Expected behavior
The first render after hydration leaves the scroll position alone. Hydration is not a navigation: the browser and the inline restoration script set the initial position, and the visitor owns it after that.
Screenshots or Videos
No response
Platform
- Router / Start version:
@tanstack/react-router1.170.46,@tanstack/router-core1.171.39,@tanstack/react-start1.169.5 (mainat 0b6d4f3 has the same code) - OS: macOS 15
- Browser: Chromium and WebKit (Playwright 1.65.1)
- Bundler: Vite 8.3.8
Additional context
RouterCore._scroll starts as { n: true } ("reset scroll on the next render", packages/router-core/src/router.ts:1148-1155). On hydration, Transitioner emits onRendered for the resolved location (packages/react-router/src/Transitioner.tsx:76-88). The onRendered listener in setupScrollRestoration reads scroll.n as true (packages/router-core/src/scroll-restoration.ts:253) and, with no cached entry on a first visit, calls scrollTo({ top: 0, left: 0 }) (:353-361).
Setting the flag in hydrate() (packages/router-core/src/load-client.ts, after router.ssr = … on line 2224) fixes it:
router._scroll.n = false
onRendered sets scroll.n back to true after that render, so later navigations are unchanged. With this line applied to @tanstack/router-core 1.171.39 in the reproducer, the test passes 10 of 10 runs (5 per browser).
I can open a PR with the change, an e2e test and a changeset.
Disclosure: this report was investigated and written with AI assistance. The reproducer was run against the published packages, with and without the change, before posting.
- Langage dominant
- TypeScript
- Étoiles
- 15.3k
- Forks
- 1.9k
- Merge moyen
- 1 j 5 h
- PR mergées (30 j)
- 46
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de TanStack/router
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
Masked navigation drops the first character of the hash each time (__tempLocation hash missing '#')Peut-être pris @hassanabrar202 l’a pris il y a 8 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
router-generator: lazy-load Prettier (costs ~300–450ms per build even when formatting is off)Peut-être pris @Sheraff l’a pris il y a 27 jours. Ouvertepackage: router-generator performance
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
router-generator: sibling `physical()` subtrees in a virtual route config generate duplicate identifiersPeut-être pris @Sheraff l’a pris il y a 27 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour
-
docs(router): clarify static title fallback in SPA modePeut-être pris @Rohan-Dedhia l’a pris il y a 17 jours. Ouverte
Difficulté 1/5 1-3 heures Accessibilité débutants 62/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de TanStack/router
Issues similaires
-
[BUG]: Shared links drop the configured basePath on GitHub PagesPeut-être pris @anshulchikhale30-p l’a pris aujourd’hui. Ouvertebug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
StabilityNexus/IdentityTokens-EVM-Frontend#182 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Add: GTrekkerOuvertecheck:passed streams:add
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Koenkk/zigbee-herdsman-converters#13900 ·
Les mainteneurs répondent en général sous 1 jour
-
area: ui Bug Payload OSS
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
payloadcms/payload#19839 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
jeanibarz/knowledge-base-mcp-server#1291 ·
Les mainteneurs répondent en général sous 1 jour