Scroll restoration scrolls the window to the top on the first render after SSR hydration

Offen
#8,933 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@pjborowiecki arbeitet bereits daran.

Seit 14.11.2026.

  • #8934 von @pjborowiecki — offen

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
  1. npm install && npx playwright install chromium webkit && npx playwright test
  2. The test holds the client scripts, scrolls the server-rendered page to 2000px, releases the scripts and waits for the router's first onRendered.
  3. window.scrollY is 0. 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-router 1.170.46, @tanstack/router-core 1.171.39, @tanstack/react-start 1.169.5 (main at 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

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TanStack/router

Alle Issues in TanStack/router

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.