0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
router/examples/react
Manuel Schiller 99df5ae424 feat: experimental route modules for file-based routing
Route modules are workspace packages that own a subtree of file-based routes and are mounted into applications or other modules. A package declares `tanstack.router.module` in its package.json. The generator gives it qualified route ids (`<pkg>:<path>`), a generated route scope (`routeScope.gen.ts` plus one namespace file per included or used module), a public contract (`routeContract.gen.ts`, exported as `./route-types` after the package's own declaration build), a runtime entry (`routeModule.gen.ts`, exported as `./route-module`) and a topology manifest (`.tanstack/route-module.json`). Includers mount modules with the `routeModules` option: `includes` chooses the host route and mount path, optionally under path params, `uses` references modules mounted elsewhere, and an application installs a module several times by including it once per installation named with `as`, each with its own namespace and route ids (`<pkg>#<as>:<path>`). Matches of module routes carry `localRouteId`, and the generated `isScopedMatch` guard narrows whole-router matches by module id prefix.

Runtime: the generated host tree mounts module roots with the internal `mountRouteModule`; module-local ids, destinations, redirects and not-found errors resolve to the installation of the route that uses them; `HostedRouter` types the links of code that mounts modules under path params. Type composition is contract-based through `./route-types`; the framework packages augment `@tanstack/router-core/extensions` and export `RouteCore`.

Start: modules get `createServerFn`, `createMiddleware` and `createStartModule` in their scope, declare required context by augmenting `StartModuleRequirements`, and contribute fragments that applications install with `createStart(() => ({ extends: startModules }))`; `startModules.gen.ts` type-checks installation and requirements. The Start plugin lists module routes in the routes manifest, selects the providers' client tree views, discovers prerenderable module pages and extends import protection to module packages.

Build and tooling: the host bundler compiles, code-splits and hot-updates module routes, including every installation; `tsr generate` and `tsr watch` are the only commands and packages own their declaration builds; the devtools show modules; the `route-module-imports` ESLint rule enforces scope imports. Fixtures cover React, Solid, Vue and Start with Vite and Rsbuild, and a large example measures builds.
History 2026-11-02 00:02:35 +01:00
..
authenticated-routes ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
authenticated-routes-firebase ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-default-search-params ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-devtools-panel ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-non-nested-devtools ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-react-query ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-react-query-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-ssr-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-ssr-streaming-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-virtual-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
basic-virtual-inside-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
deferred-data ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
i18n-paraglide ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
kitchen-sink ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
kitchen-sink-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
kitchen-sink-react-query ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
kitchen-sink-react-query-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
large-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
location-masking ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
navigation-blocking ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
quickstart ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
quickstart-esbuild-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
quickstart-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
quickstart-rspack-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
quickstart-webpack-file-based ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
router-monorepo-react-query ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
router-monorepo-simple ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
router-monorepo-simple-lazy ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
scroll-restoration ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
search-validator-adapters ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-bare ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-auth ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-authjs ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-cloudflare ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-react-query ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-rsbuild ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-basic-rsc/.devcontainer efp (#7144) 2026-04-11 01:43:05 +02:00
start-basic-static ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-bun ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-clerk-basic ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-convex-trellaux ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-counter ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-i18n-paraglide ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-large ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-large-route-modules feat: experimental route modules for file-based routing 2026-11-02 00:02:35 +01:00
start-material-ui ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-next-migration ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-rscs ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-streaming-data-from-server-functions ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-supabase-basic ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-tailwind-v4 ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-trellaux ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
start-workos ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
view-transitions ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
with-framer-motion ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
with-trpc ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00
with-trpc-react-query ci: Version Packages (#8745) 2026-10-22 22:05:39 +02:00