Scroll restoration scrolls the window to the top on the first render after SSR hydration
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- Ein halber Tag
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Bug
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- playwright, react, typescript, vite
- Bereich
- frontend
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 15.3k
- Forks
- 1.9k
- Ø Merge
- 1 T. 5 Std.
- Gemergte PRs (30 T.)
- 46
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TanStack/router
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Maintainer antworten meist innerhalb von 1 Tag
-
Masked navigation drops the first character of the hash each time (__tempLocation hash missing '#')Evtl. vergeben @hassanabrar202 hat das vor 8 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
router-generator: lazy-load Prettier (costs ~300–450ms per build even when formatting is off)Evtl. vergeben @Sheraff hat das vor 27 Tagen übernommen. Offenpackage: router-generator performance
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Maintainer antworten meist innerhalb von 1 Tag
-
router-generator: sibling `physical()` subtrees in a virtual route config generate duplicate identifiersEvtl. vergeben @Sheraff hat das vor 27 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
docs(router): clarify static title fallback in SPA modeEvtl. vergeben @Rohan-Dedhia hat das vor 17 Tagen übernommen. Offen
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in TanStack/router
Ähnliche Issues
-
[BUG]: Shared links drop the configured basePath on GitHub PagesEvtl. vergeben @anshulchikhale30-p hat das heute übernommen. Offenbug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
StabilityNexus/IdentityTokens-EVM-Frontend#182 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Add: GTrekkerOffencheck:passed streams:add
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Koenkk/zigbee-herdsman-converters#13900 ·
Maintainer antworten meist innerhalb von 1 Tag
-
area: ui Bug Payload OSS
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
payloadcms/payload#19839 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
jeanibarz/knowledge-base-mcp-server#1291 ·
Maintainer antworten meist innerhalb von 1 Tag