Merge branch 'main' into test-2255

Author: SeanCassiere

.github/renovate.json

@@ -20,6 +20,7 @@
     "@types/node",
     "@types/react",
     "@types/react-dom",
+    "h3",
     "node",
     "react",
     "react-dom",

.gitignore

@@ -55,7 +55,6 @@ ts-perf
 .netlify
 
 nx-cloud.env
-.vscode
 .nx/cache
 .nx/workspace-data
 
@@ -74,3 +73,7 @@ app.config.js.timestamp_*
 app.config.ts.timestamp_*
 .idea
 *.vitest-temp.json
+
+# Handling VSCode settings
+/.vscode/
+!/examples/react/**/.vscode/settings.json

docs/router/framework/react/api/router/useParamsHook.md

@@ -15,6 +15,13 @@ The `useParams` hook accepts an optional `options` object.
 - Optional - `default: true`
 - If `false`, the `opts.from` option will be ignored and types will be loosened to `Partial<AllParams>` to reflect the shared types of all params.
 
+### `opts.shouldThrow` option
+
+- Type: `boolean`
+- Optional
+- `default: true`
+- If `false`,`useParams` will not throw an invariant exception in case a match was not found in the currently rendered matches; in this case, it will return `undefined`.
+
 ### `opts.select` option
 
 - Optional

docs/router/framework/react/api/router/useSearchHook.md

@@ -15,6 +15,13 @@ The `useSearch` hook accepts an `options` object.
 - Required
 - The RouteID to match the search query parameters from.
 
+### `opts.shouldThrow` option
+
+- Type: `boolean`
+- Optional
+- `default: true`
+- If `false`,`useSearch` will not throw an invariant exception in case a match was not found in the currently rendered matches; in this case, it will return `undefined`.
+
 ### `opts.select` option
 
 - Type: `(search: SelectedSearchSchema) => TSelected`

docs/router/framework/react/guide/custom-search-param-serialization.md

@@ -92,6 +92,9 @@ So, if we were to turn the previous object into a search string using this confi
 ?page=1&sort=asc&filters=eyJhdXRob3IiOiJ0YW5uZXIiLCJtaW5fd29yZHMiOjgwMH0%3D
 ```
 
+> [!WARNING]
+> If you are serializing user input into Base64, you run the risk of causing a collision with the URL deserialization. This can lead to unexpected behavior, such as the URL not being parsed correctly or being interpreted as a different value. To avoid this, you should encode the search params using a safe binary encoding/decoding method (see below).
+
 ## Using the query-string library
 
 The [query-string](https://github.com/sindresorhus/query-string) library is a popular for being able to reliably parse and stringify query strings. You can use it to customize the serialization format of your search params. This can be done with the following code:

docs/router/framework/react/guide/file-based-routing.md

@@ -358,16 +358,27 @@ Here are some resources to help you ignore the generated route tree file:
 - ESLint - [https://eslint.org/docs/latest/use/configure/ignore#ignoring-files](https://eslint.org/docs/latest/use/configure/ignore#ignoring-files)
 - Biome - [https://biomejs.dev/reference/configuration/#filesignore](https://biomejs.dev/reference/configuration/#filesignore)
 
-If you are using VSCode, you can also add the following to your `.vscode/settings.json` file to exclude the generated route tree file from the editor's file watcher:
+> [!WARNING]
+> If you are using VSCode, you may experience the route tree file unexpectedly open (with errors) after renaming a route.
+
+You can prevent that from the VSCode settings by marking the file as readonly. Our recommendation is to also exclude it from search results and file watcher with the following settings:
 
 ```json
 {
+  "files.readonlyInclude": {
+    "**/routeTree.gen.ts": true
+  },
   "files.watcherExclude": {
     "**/routeTree.gen.ts": true
+  },
+  "search.exclude": {
+    "**/routeTree.gen.ts": true
   }
 }
 ```
 
+You can use those settings either at a user level or only for a single workspace by creating the file `.vscode/settings.json` at the root of your project.
+
 ## Configuration
 
 File-based routing comes with some sane defaults that should work for most projects:

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

@@ -7,6 +7,18 @@ title: Scroll Restoration
 
 Out of the box, TanStack Router supports both **hash scrolling** and **top-of-page scrolling** without any additional configuration.
 
+## Scroll-to-top & Nested Scrollable Areas
+
+By default, scroll-top-top mimics the behavior of the browser, which means only the `window` itself is scrolled to the top after successful navigation. For many apps however, it's common for the main scrollable area to be a nested div or similar because of advanced layouts. If you would like TanStack Router to also scroll these main scrollable areas for you, you can add selectors to target them using the `routerOptions.scrollToTopSelectors`:
+
+```tsx
+const router = createRouter({
+  scrollToTopSelectors: ['#main-scrollable-area'],
+})
+```
+
+These selectors are handled **in addition to `window`** which cannot be disabled currently.
+
 ## 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:

docs/router/framework/react/quick-start.md

@@ -22,7 +22,7 @@ bun create @tanstack/router
 deno init --npm @tanstack/router
 ```
 
-Follow the prompts to setup the a fully setup TanStack Router project.
+Follow the prompts to scaffold a full TanStack Router project.
 
 ### Manual Setup
 
@@ -65,7 +65,7 @@ export default defineConfig({
 ```
 
 > [!TIP]
-> If you are not using Vite, or any supported bundler, you can check out the [TanStack Router CLI](./guide/file-based-routing.md#configuration-with-the-tanstack-router-cli) guide for more info.
+> If you are not using Vite, or any of the supported bundlers, you can check out the [TanStack Router CLI](./guide/file-based-routing.md#configuration-with-the-tanstack-router-cli) guide for more info.
 
 Create the following files:
 

e2e/react-router/basic-esbuild-file-based/package.json

@@ -24,6 +24,6 @@
     "@tanstack/router-e2e-utils": "workspace:^",
     "@types/react": "^18.2.47",
     "@types/react-dom": "^18.2.18",
-    "esbuild": "^0.24.2"
+    "esbuild": "^0.25.0"
   }
 }

e2e/react-router/basic-file-based-code-splitting/package.json

@@ -27,6 +27,6 @@
     "@types/react": "^18.2.47",
     "@types/react-dom": "^18.2.18",
     "@vitejs/plugin-react": "^4.3.4",
-    "vite": "^6.0.11"
+    "vite": "^6.1.0"
   }
 }