0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
Commit graph

834 commits

Author SHA1 Message Date
Birk Skyum
83783cbe97
fix(router-docs): update notes on devtools in quickstart guide (#3769)
Closes https://github.com/TanStack/router/issues/3756
2025-03-13 22:13:58 +01:00
Birk Skyum
378720862a
docs(quickstart): use create-tsrouter-app for scaffolding a tsrouter app (#3759)
This use the new create-tsrouter-app to scaffold tsrouter apps.

On this quickstart page
https://tanstack.com/router/latest/docs/framework/react/quick-start
https://tanstack.com/router/latest/docs/framework/solid/quick-start
2025-03-12 23:31:28 +01:00
autofix-ci[bot]
a73dcdcec3
ci: apply automated fixes 2025-03-12 15:50:19 +00:00
Aleksander
5975a398af
docs: Add "response" option details to server-functions.md (#3753)
Added information about "response" option and returning non-standard
return types
2025-03-12 16:49:04 +01:00
Rolf Timmermans
92763e3ce3
Add example for virtualization for the whole window. (#3752)
Based on
https://github.com/TanStack/router/pull/3191#issuecomment-2717415282
2025-03-12 15:55:38 +01:00
Birk Skyum
1bf017aedf
fix(docs): update path-alias example from app to src (#3733) 2025-03-10 20:00:21 +01:00
Robin Hos
a73bf99f14
docs(router): Add example for search params validation with Effect/Sc… (#3710)
Added an example for validating Search Params with
[Effect](https://effect.website) because
[Effect/Schema](https://effect.website/docs/schema/standard-schema/)
also implements [Standard
Schema](https://github.com/standard-schema/standard-schema).

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-03-09 21:16:42 +01:00
Alex D'Elia
e9f7efc4bf
docs(router): improve navigation guide and NavigateOptions documentation (#3701)
This PR adds missing documentation for both the NavigationOptions type
and the Navigation guide.
2025-03-09 11:56:27 +01:00
Birk Skyum
e313a1c5a7
feat(router-devtools-core): consolidate devtools logic in core and distributed with framework-specific bindings (#3636)
The original `@tanstack/router-devtools` package still work - it's not
touch by this PR in any way, apart from a migration note saying:

>[@tanstack/router-devtools] Warning: This package has moved to
@tanstack/react-router-devtools. Please switch to the new package, as
this package will be dropped soon.

This introduce three new packages
- @tanstack/router-devtools-core : This is a SolidJS port of the UI

And two adapters on top, that mount this solid app and forward
router/routerState into it.
- @tanstack/solid-router-devtools
- @tanstack/router-router-devtools

For use of devtools in production, a `TanStackRouterDevtoolsInProd` can
be imported instead of the standard `TanStackRouterDevtools` that'll be
tree shaken away in prod.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
2025-03-08 13:20:26 +01:00
Honza Hrubý
aa24401b04
feat(router-generator): disable formatting of routeTree (#3678)
Based on the discussion in https://github.com/TanStack/router/discussions/3664, I'm adding an
option to disable the formatting of the generated routeTree. The file is not meant for human consumption and disabling the formatter can significantly speed up the route generation process.

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-03-08 10:06:39 +13:00
Kilian Finger
cd7a43c9e2
chore(examples): add Material UI example (#3677)
Fixes #2867 

As previously discussed @schiller-manuel.
2025-03-07 13:34:19 +01:00
Sean Cassiere
81c657623d
refactor(router-generator): add internal __enableAPIRoutesGeneration flag (#3685)
This internal flag makes it so that the `router-generator` only considers API Routes when `__enableAPIRoutesGeneration` is set to `true`.
2025-03-08 00:10:07 +13:00
Miciah Henderson
623e420de0
docs: streamline language in the quick-start guide for Solid (#3681) 2025-03-07 09:16:12 +13:00
Ryan Callahan
7b47db77f7
docs(start): Add note for verbatimModuleSyntax setting in tsconfig docs (#3670)
verbatimModuleSyntax can cause server bundles to quietly leak into
client bundles via exported types. It is an easy mistake to make that
can be _very_ difficult to debug.

Inspired by #3401

Co-authored-by: ryan-callahan-edo <ryan.callahan@edoinc.com>
2025-03-05 22:11:05 +01:00
Alex D'Elia
6e364a5654
docs(router): add viewTransition docs in NavigateOptionsType (#3652)
This PR adds viewTransition documentation to the NavigateOptionsType,
giving users more info on how they can use the viewTransition API in
Links and Navigates.

Will follow up in the next day or so with an example as well.
2025-03-04 08:50:50 +01:00
Julian Klumpers
5e6a774275
docs: Update server-functions.md docs (#3628)
Added clear description add the top that server functions cannot be
called from API Routes.
2025-03-02 19:39:04 +01:00
Raymond Kneipp
d8878af647
docs(start): fix installation script in "build-from-scratch" guide (#3623) 2025-03-02 17:10:34 +13:00
Melvin Valster
96d84eb062
docs: Provide default RegisteredRouter type in type-utilities examples (#3604)
The docs don't provide the default `RegisteredRouter` assignment for all
the type generics.
2025-02-28 12:39:08 +01:00
Russ Painter
b125dd5de8
Documentation proofreading (#3603)
Just some typos and a clarification in the docs.
2025-02-28 12:38:02 +01:00
Sean Cassiere
5b6fd04ec4
docs: differentiate between "layout" and "pathless layout" routes (#3599) 2025-02-28 11:43:21 +13:00
Sean Cassiere
6e5cf1f603
chore(examples): add more file-based solid-router examples (#3585) 2025-02-27 14:26:11 +13:00
Sean Cassiere
4c9eecd8d3
docs(solid-router): missing steps for tsconfig.json (#3584) 2025-02-27 13:31:02 +13:00
KoolieKangarooMjolner
de44ad7b78
docs(react-router): update import from viteReact to react (#3574)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-02-27 13:19:00 +13:00
omar
e2baa29fcc
docs(start): missing syntax snippet from static-prerendering guide (#3581)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-02-27 09:55:39 +13:00
Vikas Wakde
66991ddfbf
docs: fix path-params guide link in file-naming-conventions.md (#3576)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-02-27 08:33:42 +13:00
Manuel Schiller
71acc58835
fix: move to react-start (#3573) 2025-02-26 11:16:23 +01:00
Sean Cassiere
ab9c7f5272
docs(router): cleanup reference page for "file-based-routing" (#3569) 2025-02-26 13:41:21 +13:00
SeanCassiere
5fa2bb21f6
docs(router): rename from "guide" to "guides" 2025-02-26 12:43:40 +13:00
Sean Cassiere
74a3a06267
refactor: move routing documentation into its own section (#3567) 2025-02-26 12:33:22 +13:00
Manuel Schiller
0c0af97063 docs: rename to @tanstack/react-start 2025-02-25 22:17:33 +01:00
Tomasz Ducin
98465e1326
docs(router): syntax mistake in "document head management" guide (#3564)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
fixes #3542
2025-02-26 08:05:09 +13:00
Tomasz Ducin
9a7e0da4ce
docs: router docs update; fixes #3534 (#3562) 2025-02-25 19:02:42 +01:00
Kyle Gill
3520eab8b3
docs(router): remove inline TOC in routing concepts guide (#3543)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-02-25 11:30:22 +13:00
Sean Cassiere
d9eab3d7d6
refactor: autoCodesplitting for all (#3544) 2025-02-24 21:43:55 +13:00
Jaga Santagostino
bd73081462
docs(start): fix broken link to router docs (#3539) 2025-02-24 10:09:14 +13:00
Tanner Linsley
7081bee0b6
fix: global middleware (#3501)
Fixes global middleware via a new `app/global-middleware.ts` file
(configurable path) that is side-loaded automatically into the client
and server-fn environment to ensure registerGlobalMiddleware will run in
both environments

Fixes #3315

---------

Co-authored-by: Manuel Schiller <manuel.schiller@caligano.de>
2025-02-23 02:45:02 +01:00
Alex McLean
9864b67c86
docs(start): clarify that __root.tsx has two _ characters (#3523) 2025-02-23 12:53:46 +13:00
Sean Cassiere
76fb478cb0
docs(router): move root guides to "react" and reference in "solid" (#3519) 2025-02-22 22:47:51 +13:00
Sean Cassiere
c37d8afd45
docs(router): add existing solid examples (#3516) 2025-02-22 16:13:50 +13:00
Sean Cassiere
8678c30b00
docs(router): backfill guides for solid-router (#3509) 2025-02-22 15:52:50 +13:00
espada-edalex
5099513449
chore: update 404 route docs for file-based routing (#3506) 2025-02-21 22:54:28 +01:00
Birk Skyum
185f53691e
docs(solid-router): add getting-started pages (#3481)
* add solid installation guide

* ci: apply automated fixes

* remove react native notice

* add quck-start and overview

* solid-router imports

* move the overview to core

* ci: apply automated fixes

* add overview core page

* fix import of solidjs render

* className -> class

* fix solid overview page

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-02-21 13:16:01 -07:00
sai nivas mangu
605faf200e
docs(router): fix missing "of" in "overview.md" (#3502) 2025-02-21 19:20:40 +13:00
espada-edalex
a4619369d9
docs(router): typo in description of "route.tsx" files (#3500) 2025-02-21 19:20:22 +13:00
Jack Herrington
12ab448252
fix: doc fix for createRootRoute (#3487) 2025-02-21 00:10:02 +01:00
Christopher Horobin
7ce39ef6eb
doc: fix headings for type utilities (#3495) 2025-02-20 23:07:11 +01:00
Christopher Horobin
16a9c9e2bb
feat(react-router): final type utilities (#3485)
* feat(react-router): final type utilities

* docs(react-router): add type utilities docs
2025-02-20 22:52:57 +01:00
David Burles
b299ee8dae
docs(router): update notFound whole page example (#3466) 2025-02-20 00:57:38 +13:00
Manuel Schiller
391fbadac3
feat(start): add AbortSignal for server functions (#3477) 2025-02-19 01:49:53 +01:00
Christopher Horobin
2dd5b95a6a
refactor: remove clientAfter (#3426)
* refactor: remove clientAfter

* perf(start): add middleware types interface to avoid structural comparison

* docs(start): update to include inferring context from server to client
2025-02-18 17:37:56 +01:00