Merge branch 'main' into support-lazy-error-component-on-before-load

Author: beaussan

docs/router/config.json

@@ -577,6 +577,10 @@
               "label": "View Transitions",
               "to": "framework/react/examples/view-transitions"
             },
+            {
+              "label": "Framer Motion",
+              "to": "framework/react/examples/with-framer-motion"
+            },
             {
               "label": "With tRPC",
               "to": "framework/react/examples/with-trpc"
@@ -606,6 +610,10 @@
               "label": "Quickstart (file-based)",
               "to": "framework/solid/examples/quickstart-file-based"
             },
+            {
+              "label": "Quickstart (code-based)",
+              "to": "framework/solid/examples/quickstart"
+            },
             {
               "label": "Basic (file-based)",
               "to": "framework/solid/examples/basic-file-based"
@@ -618,6 +626,18 @@
               "label": "Basic + Solid Query (code-based)",
               "to": "framework/solid/examples/basic-solid-query"
             },
+            {
+              "label": "Basic + SSR (file-based)",
+              "to": "framework/solid/examples/basic-ssr-file-based"
+            },
+            {
+              "label": "Basic + SSR Streaming (file-based)",
+              "to": "framework/solid/examples/basic-ssr-streaming-file-based"
+            },
+            {
+              "label": "Kitchen Sink (code-based)",
+              "to": "framework/solid/examples/kitchen-sink"
+            },
             {
               "label": "Kitchen Sink (file-based)",
               "to": "framework/solid/examples/kitchen-sink-file-based"
@@ -629,6 +649,50 @@
             {
               "label": "Kitchen Sink + Solid Query (code-based)",
               "to": "framework/solid/examples/kitchen-sink-solid-query"
+            },
+            {
+              "label": "Location Masking",
+              "to": "framework/solid/examples/location-masking"
+            },
+            {
+              "label": "Authenticated Routes",
+              "to": "framework/solid/examples/authenticated-routes"
+            },
+            {
+              "label": "Scroll Restoration",
+              "to": "framework/solid/examples/scroll-restoration"
+            },
+            {
+              "label": "Deferred Data",
+              "to": "framework/solid/examples/deferred-data"
+            },
+            {
+              "label": "Navigation Blocking",
+              "to": "framework/solid/examples/navigation-blocking"
+            },
+            {
+              "label": "View Transitions",
+              "to": "framework/solid/examples/view-transitions"
+            },
+            {
+              "label": "Framer Motion",
+              "to": "framework/solid/examples/with-framer-motion"
+            },
+            {
+              "label": "With tRPC",
+              "to": "framework/solid/examples/with-trpc"
+            },
+            {
+              "label": "Monorepo basic",
+              "to": "framework/solid/examples/router-monorepo-simple"
+            },
+            {
+              "label": "Monorepo basic (with lazy loading)",
+              "to": "framework/solid/examples/router-monorepo-simple-lazy"
+            },
+            {
+              "label": "Monorepo with Solid Query",
+              "to": "framework/solid/examples/router-monorepo-solid-query"
             }
           ]
         }

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

@@ -8,7 +8,7 @@ The `MatchRouteOptions` type is used to describe the options that can be used wh
 ```tsx
 interface MatchRouteOptions {
   pending?: boolean
-  caseSensitive?: boolean
+  caseSensitive?: boolean /* @deprecated */
   includeSearch?: boolean
   fuzzy?: boolean
 }
@@ -24,11 +24,12 @@ The `MatchRouteOptions` type has the following properties:
 - Optional
 - If `true`, will match against pending location instead of the current location
 
-### `caseSensitive` property
+### ~~`caseSensitive`~~ property (deprecated)
 
 - Type: `boolean`
 - Optional
 - If `true`, will match against the current location with case sensitivity
+- Declare case sensitivity in the route definition instead, or globally for all routes using the `caseSensitive` option on the router
 
 ### `includeSearch` property
 

docs/router/framework/react/guide/code-splitting.md

@@ -104,7 +104,7 @@ If you are not able to use the automatic code-splitting feature, you can still c
 > [!IMPORTANT]
 > The `__root.tsx` route file, using either `createRootRoute` or `createRootRouteWithContext`, does not support code splitting, since it's always rendered regardless of the current route.
 
-These are the only options that `createLazyFileRoute` support:
+These are the only options that `createLazyFileRoute` supports:
 
 | Export Name         | Description                                                           |
 | ------------------- | --------------------------------------------------------------------- |

docs/router/framework/react/how-to/debug-router-issues.md

@@ -109,7 +109,7 @@ const route = createRoute({
 ```tsx
 // Debug route tree in console
 console.log('Route tree:', router.routeTree)
-console.log('All routes:', router.flatRoutes)
+console.log('All routes:', router.routesById)
 ```
 
 3. **Check Parent Route Configuration**

docs/router/framework/solid/guide/authenticated-routes.md

@@ -1,4 +1,9 @@
 ---
 ref: docs/router/framework/react/guide/authenticated-routes.md
-replace: { 'react-router': 'solid-router' }
+replace:
+  {
+    'react-router': 'solid-router',
+    'auth.isAuthenticated': 'auth.isAuthenticated()',
+    'react': 'solid',
+  }
 ---

docs/router/framework/solid/installation/with-esbuild.md

@@ -0,0 +1,99 @@
+---
+title: Installation with Esbuild
+---
+
+[//]: # 'BundlerConfiguration'
+
+To use file-based routing with **Esbuild**, you'll need to install the `@tanstack/router-plugin` package.
+
+```sh
+npm install -D @tanstack/router-plugin
+```
+
+Once installed, you'll need to add the plugin to your configuration.
+
+```tsx
+// build.js
+import * as esbuild from 'esbuild'
+import { solidPlugin } from 'esbuild-plugin-solid'
+import { tanstackRouter } from '@tanstack/router-plugin/esbuild'
+
+const isDev = process.argv.includes('--dev')
+
+const ctx = await esbuild.context({
+  entryPoints: ['src/main.tsx'],
+  outfile: 'dist/main.js',
+  minify: !isDev,
+  bundle: true,
+  format: 'esm',
+  target: ['esnext'],
+  sourcemap: true,
+  plugins: [
+    solidPlugin(),
+    tanstackRouter({ target: 'solid', autoCodeSplitting: true }),
+  ],
+})
+
+if (isDev) {
+  await ctx.watch()
+  const { host, port } = await ctx.serve({ servedir: '.', port: 3005 })
+  console.log(`Server running at http://${host || 'localhost'}:${port}`)
+} else {
+  await ctx.rebuild()
+  await ctx.dispose()
+}
+```
+
+Or, you can clone our [Quickstart Esbuild example](https://github.com/TanStack/router/tree/main/examples/solid/quickstart-esbuild-file-based) and get started.
+
+Now that you've added the plugin to your Esbuild configuration, you're all set to start using file-based routing with TanStack Router.
+
+[//]: # 'BundlerConfiguration'
+
+## Ignoring the generated route tree file
+
+If your project is configured to use a linter and/or formatter, you may want to ignore the generated route tree file. This file is managed by TanStack Router and therefore shouldn't be changed by your linter or formatter.
+
+Here are some resources to help you ignore the generated route tree file:
+
+- Prettier - [https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore](https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore)
+- 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)
+
+> [!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
+
+When using the TanStack Router Plugin with Esbuild for File-based routing, it comes with some sane defaults that should work for most projects:
+
+```json
+{
+  "routesDirectory": "./src/routes",
+  "generatedRouteTree": "./src/routeTree.gen.ts",
+  "routeFileIgnorePrefix": "-",
+  "quoteStyle": "single"
+}
+```
+
+If these defaults work for your project, you don't need to configure anything at all! However, if you need to customize the configuration, you can do so by editing the configuration object passed into the `tanstackRouter` function.
+
+You can find all the available configuration options in the [File-based Routing API Reference](../../../../api/file-based-routing.md).

docs/router/framework/solid/installation/with-rspack.md

@@ -0,0 +1,89 @@
+---
+title: Installation with Rspack
+---
+
+[//]: # 'BundlerConfiguration'
+
+To use file-based routing with **Rspack** or **Rsbuild**, you'll need to install the `@tanstack/router-plugin` package.
+
+```sh
+npm install -D @tanstack/router-plugin
+```
+
+Once installed, you'll need to add the plugin to your configuration.
+
+```tsx
+// rsbuild.config.ts
+import { defineConfig } from '@rsbuild/core'
+import { pluginBabel } from '@rsbuild/plugin-babel'
+import { pluginSolid } from '@rsbuild/plugin-solid'
+import { tanstackRouter } from '@tanstack/router-plugin/rspack'
+
+export default defineConfig({
+  plugins: [
+    pluginBabel({
+      include: /\.(?:jsx|tsx)$/,
+    }),
+    pluginSolid(),
+  ],
+  tools: {
+    rspack: {
+      plugins: [tanstackRouter({ target: 'solid', autoCodeSplitting: true })],
+    },
+  },
+})
+```
+
+Or, you can clone our [Quickstart Rspack/Rsbuild example](https://github.com/TanStack/router/tree/main/examples/solid/quickstart-rspack-file-based) and get started.
+
+Now that you've added the plugin to your Rspack/Rsbuild configuration, you're all set to start using file-based routing with TanStack Router.
+
+[//]: # 'BundlerConfiguration'
+
+## Ignoring the generated route tree file
+
+If your project is configured to use a linter and/or formatter, you may want to ignore the generated route tree file. This file is managed by TanStack Router and therefore shouldn't be changed by your linter or formatter.
+
+Here are some resources to help you ignore the generated route tree file:
+
+- Prettier - [https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore](https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore)
+- 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)
+
+> [!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
+
+When using the TanStack Router Plugin with Rspack (or Rsbuild) for File-based routing, it comes with some sane defaults that should work for most projects:
+
+```json
+{
+  "routesDirectory": "./src/routes",
+  "generatedRouteTree": "./src/routeTree.gen.ts",
+  "routeFileIgnorePrefix": "-",
+  "quoteStyle": "single"
+}
+```
+
+If these defaults work for your project, you don't need to configure anything at all! However, if you need to customize the configuration, you can do so by editing the configuration object passed into the `tanstackRouter` function.
+
+You can find all the available configuration options in the [File-based Routing API Reference](../../../../api/file-based-routing.md).