Merge branch 'main' into fix/nx-20.4-broke-lazy-loading-import-detection

TanStack · Jan 30, 2025 · 17619ee · 17619ee
2 parents 5327a21 + 830dafe
commit 17619ee
Showing 328 changed files with 2,103 additions and 920 deletions.
diff --git a/...alization-deserialization-idempotency.jpg → ...alization-deserialization-idempotency.jpg b/...alization-deserialization-idempotency.jpg → ...alization-deserialization-idempotency.jpg
diff --git a/docs/config.json → docs/router/config.json b/docs/config.json → docs/router/config.json
@@ -184,77 +184,6 @@
         }
       ]
     },
-    {
-      "label": "Start",
-      "children": [],
-      "frameworks": [
-        {
-          "label": "react",
-          "children": [
-            {
-              "label": "Overview",
-              "to": "framework/react/start/overview"
-            },
-            {
-              "label": "Getting Started",
-              "to": "framework/react/start/getting-started"
-            },
-            {
-              "label": "Quick Start",
-              "to": "framework/react/start/quick-start"
-            },
-            {
-              "label": "Build from Scratch",
-              "to": "framework/react/start/build-from-scratch"
-            },
-            {
-              "label": "Learn the Basics",
-              "to": "framework/react/start/learn-the-basics"
-            },
-            {
-              "label": "Server Functions",
-              "to": "framework/react/start/server-functions"
-            },
-            {
-              "label": "Middleware",
-              "to": "framework/react/start/middleware"
-            },
-            {
-              "label": "API Routes",
-              "to": "framework/react/start/api-routes"
-            },
-            {
-              "label": "SSR",
-              "to": "framework/react/start/ssr"
-            },
-            {
-              "label": "Hosting",
-              "to": "framework/react/start/hosting"
-            },
-            {
-              "label": "Authentication",
-              "to": "framework/react/start/authentication"
-            },
-            {
-              "label": "Databases",
-              "to": "framework/react/start/databases"
-            },
-            {
-              "label": "Observability",
-              "to": "framework/react/start/observability"
-            },
-            {
-              "label": "Static Prerendering",
-              "to": "framework/react/start/static-prerendering"
-            },
-            {
-              "label": "Path Aliases",
-              "to": "framework/react/start/path-aliases"
-            }
-          ]
-        }
-      ]
-    },
     {
       "label": "API",
       "children": [],
@@ -381,45 +310,6 @@
           ]
         }
       ]
-    },
-    {
-      "label": "Start Examples",
-      "children": [],
-      "frameworks": [
-        {
-          "label": "react",
-          "children": [
-            {
-              "label": "Basic",
-              "to": "framework/react/examples/start-basic"
-            },
-            {
-              "label": "Basic + React Query",
-              "to": "framework/react/examples/start-basic-react-query"
-            },
-            {
-              "label": "Basic + Clerk Auth",
-              "to": "framework/react/examples/start-clerk-basic"
-            },
-            {
-              "label": "Basic + DIY Auth",
-              "to": "framework/react/examples/start-basic-auth"
-            },
-            {
-              "label": "Basic + Supabase Auth",
-              "to": "framework/react/examples/start-supabase-basic"
-            },
-            {
-              "label": "Trellaux + Convex",
-              "to": "framework/react/examples/start-convex-trellaux"
-            },
-            {
-              "label": "Trellaux",
-              "to": "framework/react/examples/start-trellaux"
-            }
-          ]
-        }
-      ]
     }
   ]
 }
diff --git a/docs/eslint/create-route-property-order.md → ...ter/eslint/create-route-property-order.md b/docs/eslint/create-route-property-order.md → ...ter/eslint/create-route-property-order.md
diff --git a/docs/eslint/eslint-plugin-router.md → docs/router/eslint/eslint-plugin-router.md b/docs/eslint/eslint-plugin-router.md → docs/router/eslint/eslint-plugin-router.md
diff --git a/docs/framework/react/api/router.md → docs/router/framework/react/api/router.md b/docs/framework/react/api/router.md → docs/router/framework/react/api/router.md
diff --git a/...react/api/router/ActiveLinkOptionsType.md → ...react/api/router/ActiveLinkOptionsType.md b/...react/api/router/ActiveLinkOptionsType.md → ...react/api/router/ActiveLinkOptionsType.md
diff --git a/...act/api/router/AsyncRouteComponentType.md → ...act/api/router/AsyncRouteComponentType.md b/...act/api/router/AsyncRouteComponentType.md → ...act/api/router/AsyncRouteComponentType.md
diff --git a/...mework/react/api/router/FileRouteClass.md → ...mework/react/api/router/FileRouteClass.md b/...mework/react/api/router/FileRouteClass.md → ...mework/react/api/router/FileRouteClass.md
diff --git a/...ework/react/api/router/LinkOptionsType.md → ...ework/react/api/router/LinkOptionsType.md b/...ework/react/api/router/LinkOptionsType.md → ...ework/react/api/router/LinkOptionsType.md
diff --git a/...amework/react/api/router/LinkPropsType.md → ...amework/react/api/router/LinkPropsType.md b/...amework/react/api/router/LinkPropsType.md → ...amework/react/api/router/LinkPropsType.md
diff --git a/...react/api/router/MatchRouteOptionsType.md → ...react/api/router/MatchRouteOptionsType.md b/...react/api/router/MatchRouteOptionsType.md → ...react/api/router/MatchRouteOptionsType.md
diff --git a/...k/react/api/router/NavigateOptionsType.md → ...k/react/api/router/NavigateOptionsType.md b/...k/react/api/router/NavigateOptionsType.md → ...k/react/api/router/NavigateOptionsType.md
diff --git a/...ork/react/api/router/NotFoundErrorType.md → ...ork/react/api/router/NotFoundErrorType.md b/...ork/react/api/router/NotFoundErrorType.md → ...ork/react/api/router/NotFoundErrorType.md
diff --git a/...rk/react/api/router/NotFoundRouteClass.md → ...rk/react/api/router/NotFoundRouteClass.md b/...rk/react/api/router/NotFoundRouteClass.md → ...rk/react/api/router/NotFoundRouteClass.md
diff --git a/...eact/api/router/ParsedHistoryStateType.md → ...eact/api/router/ParsedHistoryStateType.md b/...eact/api/router/ParsedHistoryStateType.md → ...eact/api/router/ParsedHistoryStateType.md
diff --git a/...rk/react/api/router/ParsedLocationType.md → ...rk/react/api/router/ParsedLocationType.md b/...rk/react/api/router/ParsedLocationType.md → ...rk/react/api/router/ParsedLocationType.md
diff --git a/...ramework/react/api/router/RedirectType.md → ...ramework/react/api/router/RedirectType.md b/...ramework/react/api/router/RedirectType.md → ...ramework/react/api/router/RedirectType.md
diff --git a/...ramework/react/api/router/RegisterType.md → ...ramework/react/api/router/RegisterType.md b/...ramework/react/api/router/RegisterType.md → ...ramework/react/api/router/RegisterType.md
diff --git a/...mework/react/api/router/RootRouteClass.md → ...mework/react/api/router/RootRouteClass.md b/...mework/react/api/router/RootRouteClass.md → ...mework/react/api/router/RootRouteClass.md
diff --git a/...amework/react/api/router/RouteApiClass.md → ...amework/react/api/router/RouteApiClass.md b/...amework/react/api/router/RouteApiClass.md → ...amework/react/api/router/RouteApiClass.md
diff --git a/...ramework/react/api/router/RouteApiType.md → ...ramework/react/api/router/RouteApiType.md b/...ramework/react/api/router/RouteApiType.md → ...ramework/react/api/router/RouteApiType.md
diff --git a/.../framework/react/api/router/RouteClass.md → .../framework/react/api/router/RouteClass.md b/.../framework/react/api/router/RouteClass.md → .../framework/react/api/router/RouteClass.md
diff --git a/...amework/react/api/router/RouteMaskType.md → ...amework/react/api/router/RouteMaskType.md b/...amework/react/api/router/RouteMaskType.md → ...amework/react/api/router/RouteMaskType.md
diff --git a/...mework/react/api/router/RouteMatchType.md → ...mework/react/api/router/RouteMatchType.md b/...mework/react/api/router/RouteMatchType.md → ...mework/react/api/router/RouteMatchType.md
diff --git a/...work/react/api/router/RouteOptionsType.md → ...work/react/api/router/RouteOptionsType.md b/...work/react/api/router/RouteOptionsType.md → ...work/react/api/router/RouteOptionsType.md
diff --git a/docs/framework/react/api/router/RouteType.md → ...r/framework/react/api/router/RouteType.md b/docs/framework/react/api/router/RouteType.md → ...r/framework/react/api/router/RouteType.md
diff --git a/...framework/react/api/router/RouterClass.md → ...framework/react/api/router/RouterClass.md b/...framework/react/api/router/RouterClass.md → ...framework/react/api/router/RouterClass.md
diff --git a/...work/react/api/router/RouterEventsType.md → ...work/react/api/router/RouterEventsType.md b/...work/react/api/router/RouterEventsType.md → ...work/react/api/router/RouterEventsType.md
@@ -9,39 +9,48 @@ The `RouterEvents` type contains all of the events that the router can emit. Eac
 type RouterEvents = {
   onBeforeNavigate: {
     type: 'onBeforeNavigate'
-    fromLocation: ParsedLocation
+    fromLocation?: ParsedLocation
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
   }
   onBeforeLoad: {
     type: 'onBeforeLoad'
-    fromLocation: ParsedLocation
+    fromLocation?: ParsedLocation
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
   }
   onLoad: {
     type: 'onLoad'
-    fromLocation: ParsedLocation
+    fromLocation?: ParsedLocation
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
   }
   onResolved: {
     type: 'onResolved'
-    fromLocation: ParsedLocation
+    fromLocation?: ParsedLocation
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
   }
   onBeforeRouteMount: {
     type: 'onBeforeRouteMount'
-    fromLocation: ParsedLocation
+    fromLocation?: ParsedLocation
     toLocation: ParsedLocation
     pathChanged: boolean
     hrefChanged: boolean
   }
+  onInjectedHtml: {
+    type: 'onInjectedHtml'
+    promise: Promise<string>
+  }
+  onRendered: {
+    type: 'onRendered'
+    fromLocation?: ParsedLocation
+    toLocation: ParsedLocation
+  }
 }
 ```
 

diff --git a/...ork/react/api/router/RouterOptionsType.md → ...ork/react/api/router/RouterOptionsType.md b/...ork/react/api/router/RouterOptionsType.md → ...ork/react/api/router/RouterOptionsType.md
diff --git a/...ework/react/api/router/RouterStateType.md → ...ework/react/api/router/RouterStateType.md b/...ework/react/api/router/RouterStateType.md → ...ework/react/api/router/RouterStateType.md
diff --git a/.../framework/react/api/router/RouterType.md → .../framework/react/api/router/RouterType.md b/.../framework/react/api/router/RouterType.md → .../framework/react/api/router/RouterType.md
diff --git a/...ork/react/api/router/ToMaskOptionsType.md → ...ork/react/api/router/ToMaskOptionsType.md b/...ork/react/api/router/ToMaskOptionsType.md → ...ork/react/api/router/ToMaskOptionsType.md
diff --git a/...amework/react/api/router/ToOptionsType.md → ...amework/react/api/router/ToOptionsType.md b/...amework/react/api/router/ToOptionsType.md → ...amework/react/api/router/ToOptionsType.md
diff --git a/...ct/api/router/UseMatchRouteOptionsType.md → ...ct/api/router/UseMatchRouteOptionsType.md b/...ct/api/router/UseMatchRouteOptionsType.md → ...ct/api/router/UseMatchRouteOptionsType.md
diff --git a/...t/api/router/ViewTransitionOptionsType.md → ...t/api/router/ViewTransitionOptionsType.md b/...t/api/router/ViewTransitionOptionsType.md → ...t/api/router/ViewTransitionOptionsType.md
diff --git a/...mework/react/api/router/awaitComponent.md → ...mework/react/api/router/awaitComponent.md b/...mework/react/api/router/awaitComponent.md → ...mework/react/api/router/awaitComponent.md
diff --git a/...eact/api/router/catchBoundaryComponent.md → ...eact/api/router/catchBoundaryComponent.md b/...eact/api/router/catchBoundaryComponent.md → ...eact/api/router/catchBoundaryComponent.md
diff --git a/...eact/api/router/catchNotFoundComponent.md → ...eact/api/router/catchNotFoundComponent.md b/...eact/api/router/catchNotFoundComponent.md → ...eact/api/router/catchNotFoundComponent.md
diff --git a/...act/api/router/createFileRouteFunction.md → ...act/api/router/createFileRouteFunction.md b/...act/api/router/createFileRouteFunction.md → ...act/api/router/createFileRouteFunction.md
diff --git a/...api/router/createLazyFileRouteFunction.md → ...api/router/createLazyFileRouteFunction.md b/...api/router/createLazyFileRouteFunction.md → ...api/router/createLazyFileRouteFunction.md
diff --git a/...act/api/router/createLazyRouteFunction.md → ...act/api/router/createLazyRouteFunction.md b/...act/api/router/createLazyRouteFunction.md → ...act/api/router/createLazyRouteFunction.md
diff --git a/...act/api/router/createRootRouteFunction.md → ...act/api/router/createRootRouteFunction.md b/...act/api/router/createRootRouteFunction.md → ...act/api/router/createRootRouteFunction.md
diff --git a/...ter/createRootRouteWithContextFunction.md → ...ter/createRootRouteWithContextFunction.md b/...ter/createRootRouteWithContextFunction.md → ...ter/createRootRouteWithContextFunction.md
diff --git a/...k/react/api/router/createRouteFunction.md → ...k/react/api/router/createRouteFunction.md b/...k/react/api/router/createRouteFunction.md → ...k/react/api/router/createRouteFunction.md
diff --git a/...act/api/router/createRouteMaskFunction.md → ...act/api/router/createRouteMaskFunction.md b/...act/api/router/createRouteMaskFunction.md → ...act/api/router/createRouteMaskFunction.md
diff --git a/.../react/api/router/createRouterFunction.md → .../react/api/router/createRouterFunction.md b/.../react/api/router/createRouterFunction.md → .../react/api/router/createRouterFunction.md
diff --git a/.../router/defaultGlobalNotFoundComponent.md → .../router/defaultGlobalNotFoundComponent.md b/.../router/defaultGlobalNotFoundComponent.md → .../router/defaultGlobalNotFoundComponent.md
diff --git a/...amework/react/api/router/deferFunction.md → ...amework/react/api/router/deferFunction.md b/...amework/react/api/router/deferFunction.md → ...amework/react/api/router/deferFunction.md
diff --git a/...act/api/router/errorComponentComponent.md → ...act/api/router/errorComponentComponent.md b/...act/api/router/errorComponentComponent.md → ...act/api/router/errorComponentComponent.md
diff --git a/...k/react/api/router/getRouteApiFunction.md → ...k/react/api/router/getRouteApiFunction.md b/...k/react/api/router/getRouteApiFunction.md → ...k/react/api/router/getRouteApiFunction.md
diff --git a/...react/api/router/historyStateInterface.md → ...react/api/router/historyStateInterface.md b/...react/api/router/historyStateInterface.md → ...react/api/router/historyStateInterface.md
diff --git a/...rk/react/api/router/isNotFoundFunction.md → ...rk/react/api/router/isNotFoundFunction.md b/...rk/react/api/router/isNotFoundFunction.md → ...rk/react/api/router/isNotFoundFunction.md
diff --git a/...rk/react/api/router/isRedirectFunction.md → ...rk/react/api/router/isRedirectFunction.md b/...rk/react/api/router/isRedirectFunction.md → ...rk/react/api/router/isRedirectFunction.md
diff --git a/.../api/router/lazyRouteComponentFunction.md → .../api/router/lazyRouteComponentFunction.md b/.../api/router/lazyRouteComponentFunction.md → .../api/router/lazyRouteComponentFunction.md
diff --git a/...amework/react/api/router/linkComponent.md → ...amework/react/api/router/linkComponent.md b/...amework/react/api/router/linkComponent.md → ...amework/react/api/router/linkComponent.md
diff --git a/...framework/react/api/router/linkOptions.md → ...framework/react/api/router/linkOptions.md b/...framework/react/api/router/linkOptions.md → ...framework/react/api/router/linkOptions.md
diff --git a/...k/react/api/router/matchRouteComponent.md → ...k/react/api/router/matchRouteComponent.md b/...k/react/api/router/matchRouteComponent.md → ...k/react/api/router/matchRouteComponent.md
diff --git a/...ork/react/api/router/navigateComponent.md → ...ork/react/api/router/navigateComponent.md b/...ork/react/api/router/navigateComponent.md → ...ork/react/api/router/navigateComponent.md
diff --git a/...work/react/api/router/notFoundFunction.md → ...work/react/api/router/notFoundFunction.md b/...work/react/api/router/notFoundFunction.md → ...work/react/api/router/notFoundFunction.md
diff --git a/...ework/react/api/router/outletComponent.md → ...ework/react/api/router/outletComponent.md b/...ework/react/api/router/outletComponent.md → ...ework/react/api/router/outletComponent.md
diff --git a/...work/react/api/router/redirectFunction.md → ...work/react/api/router/redirectFunction.md b/...work/react/api/router/redirectFunction.md → ...work/react/api/router/redirectFunction.md
diff --git a/.../api/router/retainSearchParamsFunction.md → .../api/router/retainSearchParamsFunction.md b/.../api/router/retainSearchParamsFunction.md → .../api/router/retainSearchParamsFunction.md
diff --git a/...pi/router/rootRouteWithContextFunction.md → ...pi/router/rootRouteWithContextFunction.md b/...pi/router/rootRouteWithContextFunction.md → ...pi/router/rootRouteWithContextFunction.md
diff --git a/...t/api/router/stripSearchParamsFunction.md → ...t/api/router/stripSearchParamsFunction.md b/...t/api/router/stripSearchParamsFunction.md → ...t/api/router/stripSearchParamsFunction.md
diff --git a/...mework/react/api/router/useAwaitedHook.md → ...mework/react/api/router/useAwaitedHook.md b/...mework/react/api/router/useAwaitedHook.md → ...mework/react/api/router/useAwaitedHook.md
diff --git a/...mework/react/api/router/useBlockerHook.md → ...mework/react/api/router/useBlockerHook.md b/...mework/react/api/router/useBlockerHook.md → ...mework/react/api/router/useBlockerHook.md
diff --git a/...ramework/react/api/router/useCanGoBack.md → ...ramework/react/api/router/useCanGoBack.md b/...ramework/react/api/router/useCanGoBack.md → ...ramework/react/api/router/useCanGoBack.md
diff --git a/...k/react/api/router/useChildMatchesHook.md → ...k/react/api/router/useChildMatchesHook.md b/...k/react/api/router/useChildMatchesHook.md → ...k/react/api/router/useChildMatchesHook.md
diff --git a/...work/react/api/router/useLinkPropsHook.md → ...work/react/api/router/useLinkPropsHook.md b/...work/react/api/router/useLinkPropsHook.md → ...work/react/api/router/useLinkPropsHook.md
diff --git a/...ork/react/api/router/useLoaderDataHook.md → ...ork/react/api/router/useLoaderDataHook.md b/...ork/react/api/router/useLoaderDataHook.md → ...ork/react/api/router/useLoaderDataHook.md
diff --git a/...ork/react/api/router/useLoaderDepsHook.md → ...ork/react/api/router/useLoaderDepsHook.md b/...ork/react/api/router/useLoaderDepsHook.md → ...ork/react/api/router/useLoaderDepsHook.md
diff --git a/...ework/react/api/router/useLocationHook.md → ...ework/react/api/router/useLocationHook.md b/...ework/react/api/router/useLocationHook.md → ...ework/react/api/router/useLocationHook.md
diff --git a/...ramework/react/api/router/useMatchHook.md → ...ramework/react/api/router/useMatchHook.md b/...ramework/react/api/router/useMatchHook.md → ...ramework/react/api/router/useMatchHook.md
diff --git a/...ork/react/api/router/useMatchRouteHook.md → ...ork/react/api/router/useMatchRouteHook.md b/...ork/react/api/router/useMatchRouteHook.md → ...ork/react/api/router/useMatchRouteHook.md
diff --git a/...mework/react/api/router/useMatchesHook.md → ...mework/react/api/router/useMatchesHook.md b/...mework/react/api/router/useMatchesHook.md → ...mework/react/api/router/useMatchesHook.md
diff --git a/...ework/react/api/router/useNavigateHook.md → ...ework/react/api/router/useNavigateHook.md b/...ework/react/api/router/useNavigateHook.md → ...ework/react/api/router/useNavigateHook.md
diff --git a/...amework/react/api/router/useParamsHook.md → ...amework/react/api/router/useParamsHook.md b/...amework/react/api/router/useParamsHook.md → ...amework/react/api/router/useParamsHook.md
diff --git a/.../react/api/router/useParentMatchesHook.md → .../react/api/router/useParentMatchesHook.md b/.../react/api/router/useParentMatchesHook.md → .../react/api/router/useParentMatchesHook.md
diff --git a/...k/react/api/router/useRouteContextHook.md → ...k/react/api/router/useRouteContextHook.md b/...k/react/api/router/useRouteContextHook.md → ...k/react/api/router/useRouteContextHook.md
diff --git a/...amework/react/api/router/useRouterHook.md → ...amework/react/api/router/useRouterHook.md b/...amework/react/api/router/useRouterHook.md → ...amework/react/api/router/useRouterHook.md
diff --git a/...rk/react/api/router/useRouterStateHook.md → ...rk/react/api/router/useRouterStateHook.md b/...rk/react/api/router/useRouterStateHook.md → ...rk/react/api/router/useRouterStateHook.md
diff --git a/...amework/react/api/router/useSearchHook.md → ...amework/react/api/router/useSearchHook.md b/...amework/react/api/router/useSearchHook.md → ...amework/react/api/router/useSearchHook.md
diff --git a/docs/framework/react/comparison.md → docs/router/framework/react/comparison.md b/docs/framework/react/comparison.md → docs/router/framework/react/comparison.md
@@ -57,6 +57,8 @@ Feature/Capability Key:
 | `<Block>`/`useBlocker`                         | ✅                                               | 🔶                                                    | ❓                                                    |
 | Deferred Primitives                            | ✅                                               | ✅                                                    | ✅                                                    |
 | Navigation Scroll Restoration                  | ✅                                               | ✅                                                    | ❓                                                    |
+| ElementScroll Restoration                      | ✅                                               | 🛑                                                    | 🛑                                                    |
+| Async Scroll Restoration                       | ✅                                               | 🛑                                                    | 🛑                                                    |
 | Router Invalidation                            | ✅                                               | ✅                                                    | ✅                                                    |
 | Runtime Route Manipulation (Fog of War)        | 🛑                                               | ✅                                                    | ✅                                                    |
 | --                                             | --                                               | --                                                    | --                                                    |

diff --git a/docs/framework/react/decisions-on-dx.md → ...router/framework/react/decisions-on-dx.md b/docs/framework/react/decisions-on-dx.md → ...router/framework/react/decisions-on-dx.md
diff --git a/docs/framework/react/devtools.md → docs/router/framework/react/devtools.md b/docs/framework/react/devtools.md → docs/router/framework/react/devtools.md
diff --git a/...ework/react/guide/authenticated-routes.md → ...ework/react/guide/authenticated-routes.md b/...ework/react/guide/authenticated-routes.md → ...ework/react/guide/authenticated-routes.md
diff --git a/...amework/react/guide/code-based-routing.md → ...amework/react/guide/code-based-routing.md b/...amework/react/guide/code-based-routing.md → ...amework/react/guide/code-based-routing.md
diff --git a/docs/framework/react/guide/code-splitting.md → ...r/framework/react/guide/code-splitting.md b/docs/framework/react/guide/code-splitting.md → ...r/framework/react/guide/code-splitting.md
diff --git a/...ramework/react/guide/creating-a-router.md → ...ramework/react/guide/creating-a-router.md b/...ramework/react/guide/creating-a-router.md → ...ramework/react/guide/creating-a-router.md
diff --git a/docs/framework/react/guide/custom-link.md → ...uter/framework/react/guide/custom-link.md b/docs/framework/react/guide/custom-link.md → ...uter/framework/react/guide/custom-link.md
diff --git a/...uide/custom-search-param-serialization.md → ...uide/custom-search-param-serialization.md b/...uide/custom-search-param-serialization.md → ...uide/custom-search-param-serialization.md
diff --git a/docs/framework/react/guide/data-loading.md → ...ter/framework/react/guide/data-loading.md b/docs/framework/react/guide/data-loading.md → ...ter/framework/react/guide/data-loading.md
diff --git a/docs/framework/react/guide/data-mutations.md → ...r/framework/react/guide/data-mutations.md b/docs/framework/react/guide/data-mutations.md → ...r/framework/react/guide/data-mutations.md
diff --git a/...work/react/guide/deferred-data-loading.md → ...work/react/guide/deferred-data-loading.md b/...work/react/guide/deferred-data-loading.md → ...work/react/guide/deferred-data-loading.md
diff --git a/...work/react/guide/external-data-loading.md → ...work/react/guide/external-data-loading.md b/...work/react/guide/external-data-loading.md → ...work/react/guide/external-data-loading.md
diff --git a/...amework/react/guide/file-based-routing.md → ...amework/react/guide/file-based-routing.md b/...amework/react/guide/file-based-routing.md → ...amework/react/guide/file-based-routing.md
diff --git a/docs/framework/react/guide/history-types.md → ...er/framework/react/guide/history-types.md b/docs/framework/react/guide/history-types.md → ...er/framework/react/guide/history-types.md
diff --git a/docs/framework/react/guide/link-options.md → ...ter/framework/react/guide/link-options.md b/docs/framework/react/guide/link-options.md → ...ter/framework/react/guide/link-options.md
diff --git a/...mework/react/guide/navigation-blocking.md → ...mework/react/guide/navigation-blocking.md b/...mework/react/guide/navigation-blocking.md → ...mework/react/guide/navigation-blocking.md
diff --git a/docs/framework/react/guide/navigation.md → ...outer/framework/react/guide/navigation.md b/docs/framework/react/guide/navigation.md → ...outer/framework/react/guide/navigation.md
diff --git a/...framework/react/guide/not-found-errors.md → ...framework/react/guide/not-found-errors.md b/...framework/react/guide/not-found-errors.md → ...framework/react/guide/not-found-errors.md
diff --git a/docs/framework/react/guide/outlets.md → docs/router/framework/react/guide/outlets.md b/docs/framework/react/guide/outlets.md → docs/router/framework/react/guide/outlets.md
diff --git a/.../framework/react/guide/parallel-routes.md → .../framework/react/guide/parallel-routes.md b/.../framework/react/guide/parallel-routes.md → .../framework/react/guide/parallel-routes.md
diff --git a/docs/framework/react/guide/path-params.md → ...uter/framework/react/guide/path-params.md b/docs/framework/react/guide/path-params.md → ...uter/framework/react/guide/path-params.md
diff --git a/docs/framework/react/guide/preloading.md → ...outer/framework/react/guide/preloading.md b/docs/framework/react/guide/preloading.md → ...outer/framework/react/guide/preloading.md
diff --git a/...ework/react/guide/render-optimizations.md → ...ework/react/guide/render-optimizations.md b/...ework/react/guide/render-optimizations.md → ...ework/react/guide/render-optimizations.md
diff --git a/docs/framework/react/guide/route-masking.md → ...er/framework/react/guide/route-masking.md b/docs/framework/react/guide/route-masking.md → ...er/framework/react/guide/route-masking.md
diff --git a/docs/framework/react/guide/route-matching.md → ...r/framework/react/guide/route-matching.md b/docs/framework/react/guide/route-matching.md → ...r/framework/react/guide/route-matching.md
diff --git a/docs/framework/react/guide/route-trees.md → ...uter/framework/react/guide/route-trees.md b/docs/framework/react/guide/route-trees.md → ...uter/framework/react/guide/route-trees.md
diff --git a/docs/framework/react/guide/router-context.md → ...r/framework/react/guide/router-context.md b/docs/framework/react/guide/router-context.md → ...r/framework/react/guide/router-context.md
diff --git a/...framework/react/guide/routing-concepts.md → ...framework/react/guide/routing-concepts.md b/...framework/react/guide/routing-concepts.md → ...framework/react/guide/routing-concepts.md
diff --git a/...amework/react/guide/scroll-restoration.md → ...amework/react/guide/scroll-restoration.md b/...amework/react/guide/scroll-restoration.md → ...amework/react/guide/scroll-restoration.md
@@ -3,6 +3,12 @@ id: scroll-restoration
 title: Scroll Restoration
 ---
 
+## Hash/Top-of-Page Scrolling
+
+Out of the box, TanStack Router supports both **hash scrolling** and **top-of-page scrolling** without any additional configuration.
+
+## Scroll Restoration
+
 Scroll restoration is the process of restoring the scroll position of a page when the user navigates back to it. This is normally a built-in feature for standard HTML based websites, but can be difficult to replicate for SPA applications because:
 
 - SPAs typically use the `history.pushState` API for navigation, so the browser doesn't know to restore the scroll position natively
@@ -24,19 +30,15 @@ It does this by:
 That may sound like a lot, but for you, it's as simple as this:
 
 ```tsx
-import { ScrollRestoration } from '@tanstack/react-router'
+import { createRouter } from '@tanstack/react-router'
 
-function Root() {
-  return (
-    <>
-      <ScrollRestoration />
-      <Outlet />
-    </>
-  )
-}
+const router = createRouter({
+  scrollRestoration: true,
+})
 ```
 
-Just render the `ScrollRestoration` component (or use the `useScrollRestoration` hook) at the root of your application and it will handle everything automatically!
+> [!NOTE]
+> The `<ScrollRestoration />` component still works, but has been deprecated.
 
 ## Custom Cache Keys
 
@@ -51,38 +53,26 @@ The default `getKey` is `(location) => location.state.key!`, where `key` is the
 You could sync scrolling to the pathname:
 
 ```tsx
-import { ScrollRestoration } from '@tanstack/react-router'
+import { createRouter } from '@tanstack/react-router'
 
-function Root() {
-  return (
-    <>
-      <ScrollRestoration getKey={(location) => location.pathname} />
-      <Outlet />
-    </>
-  )
-}
+const router = createRouter({
+  getScrollRestorationKey: (location) => location.pathname,
+})
 ```
 
 You can conditionally sync only some paths, then use the key for the rest:
 
 ```tsx
-import { ScrollRestoration } from '@tanstack/react-router'
-
-function Root() {
-  return (
-    <>
-      <ScrollRestoration
-        getKey={(location) => {
-          const paths = ['/', '/chat']
-          return paths.includes(location.pathname)
-            ? location.pathname
-            : location.state.key!
-        }}
-      />
-      <Outlet />
-    </>
-  )
-}
+import { createRouter } from '@tanstack/react-router'
+
+const router = createRouter({
+  getScrollRestorationKey: (location) => {
+    const paths = ['/', '/chat']
+    return paths.includes(location.pathname)
+      ? location.pathname
+      : location.state.key!
+  },
+})
 ```
 
 ## Preventing Scroll Restoration
@@ -143,14 +133,9 @@ function Component() {
 To control the scroll behavior when navigating between pages, you can use the `scrollBehavior` option. This allows you to make the transition between pages instant instead of a smooth scroll. The global configuration of scroll restoration behavior has the same options as those supported by the browser, which are `smooth`, `instant`, and `auto` (see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView#behavior) for more information).
 
 ```tsx
-import { ScrollRestoration } from '@tanstack/react-router'
+import { createRouter } from '@tanstack/react-router'
 
-function Root() {
-  return (
-    <>
-      <ScrollRestoration scrollBehavior="instant" />
-      <Outlet />
-    </>
-  )
-}
+const router = createRouter({
+  scrollBehavior: 'instant',
+})
 ```
diff --git a/docs/framework/react/guide/search-params.md → ...er/framework/react/guide/search-params.md b/docs/framework/react/guide/search-params.md → ...er/framework/react/guide/search-params.md
diff --git a/docs/framework/react/guide/ssr.md → docs/router/framework/react/guide/ssr.md b/docs/framework/react/guide/ssr.md → docs/router/framework/react/guide/ssr.md
diff --git a/...ramework/react/guide/static-route-data.md → ...ramework/react/guide/static-route-data.md b/...ramework/react/guide/static-route-data.md → ...ramework/react/guide/static-route-data.md
diff --git a/docs/framework/react/guide/tanstack-start.md → ...r/framework/react/guide/tanstack-start.md b/docs/framework/react/guide/tanstack-start.md → ...r/framework/react/guide/tanstack-start.md
diff --git a/docs/framework/react/guide/type-safety.md → ...uter/framework/react/guide/type-safety.md b/docs/framework/react/guide/type-safety.md → ...uter/framework/react/guide/type-safety.md
diff --git a/...mework/react/guide/virtual-file-routes.md → ...mework/react/guide/virtual-file-routes.md b/...mework/react/guide/virtual-file-routes.md → ...mework/react/guide/virtual-file-routes.md
diff --git a/docs/framework/react/installation.md → docs/router/framework/react/installation.md b/docs/framework/react/installation.md → docs/router/framework/react/installation.md
diff --git a/...work/react/migrate-from-react-location.md → ...work/react/migrate-from-react-location.md b/...work/react/migrate-from-react-location.md → ...work/react/migrate-from-react-location.md
diff --git a/...mework/react/migrate-from-react-router.md → ...mework/react/migrate-from-react-router.md b/...mework/react/migrate-from-react-router.md → ...mework/react/migrate-from-react-router.md
diff --git a/docs/framework/react/overview.md → docs/router/framework/react/overview.md b/docs/framework/react/overview.md → docs/router/framework/react/overview.md
diff --git a/docs/framework/react/quick-start.md → docs/router/framework/react/quick-start.md b/docs/framework/react/quick-start.md → docs/router/framework/react/quick-start.md