refactor(react-router): expose scrollBehavior on the ScrollRestoration component

[joshuaKnauber]

Exposes the scroll behavior option for the ScrollRestoration component.

Currently the scrollTo only receives the x and y which makes it animate smoothly. If we always want to force an instant jump to the last point we should be able to set the behavior.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 8d03040.

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:unit,tes...	✅ Succeeded	4m 14s	View ↗
nx run-many --target=build --exclude=examples/*...	✅ Succeeded	43s	View ↗

---

☁️ Nx Cloud last updated this comment at 2024-12-21 23:46:39 UTC

[pkg-pr-new]

Open in Stackblitz

More templates

• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-file-based-codesplitting
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-rsc
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-example-large
• tanstack-start-example-supabase-basic
• tanstack-start-example-trellaux
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3053

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3053

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@3053

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3053

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3053

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3053

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@3053

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3053

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@3053

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@3053

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@3053

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@3053

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@3053

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3053

@tanstack/start-vite-plugin

npm i https://pkg.pr.new/@tanstack/start-vite-plugin@3053

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3053

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3053

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3053

commit: 8d03040

[SeanCassiere]

@joshuaKnauber looks like your changing of the import ordering in the packages/react-router/src/scroll-restoration.tsx file has broken eslint. Please use the eslint suggestions and fix the ordering.

[schiller-manuel]

please update docs

docs/framework/react/guide/scroll-restoration.md

[SeanCassiere]

@joshuaKnauber thank you for contributing this in 🎉

[joshuaKnauber]

@joshuaKnauber thank you for contributing this in 🎉

Thank you for reviewing and for all your guys work!