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

1,257 commits

Author SHA1 Message Date
Kid
d1e78bb5f6
docs(router): fix broken link to example in authenticated routes guide (#3937) 2025-04-05 13:53:14 +13:00
Tanner Linsley
359d19a115 Update partners 2025-04-04 13:29:24 -06:00
TN
37fc7e82df
docs: Update scroll-restoration.md (#3934)
Fix typo
2025-04-04 01:35:41 +02:00
Ehtisham Sajjad
dbfea0d08c
docs(router): simplify route variable naming in search params guide (#3890)
In the "search params" guide, the usage of the variable
`allProductsRoute` has been changed to `Route` in the code-block
examples for consistency and clarity.
This makes the examples easier to follow since `Route` is used
throughout the rest of the documentation.
2025-04-02 09:07:41 +13:00
Diego Garcia Brisa
eab355aa69
docs: Fix HeadContent docs (#3905)
## Changes

1. **Fix createRootRoute syntax**: Updated all examples in the document
head management guide to use the correct `createRootRoute({...})` syntax
instead of the incorrect `createRootRoute()({...})` syntax.

2. **Fix HeadContent placement**: The previous commit corrected the code
example for Single-Page Applications to properly show the correct syntax
for creating a root route with HeadContent.

## Why these changes matter

- The incorrect syntax examples could lead to confusion for developers
implementing document head management in their applications
- These fixes ensure consistency throughout the documentation and
provide developers with the correct implementation patterns
- Proper documentation helps reduce support requests and improves
developer experience

## Technical details

- Fixed 5 instances of incorrect `createRootRoute()({...})` syntax
throughout the document
- Previously fixed the SPA example which had an incorrect API reference

These changes ensure that all code examples in the document head
management guide are correct and consistent with the actual API
implementation.
2025-04-01 10:21:46 +02:00
Redbird10
1bbe4a062a
docs(router): correct ReturnType of Router.matchRoute to match the runtime output (#3896)
The `.matchRoute` method on the Router type page previously stated it
returns a `RouteMatch` object. In reality, it returns only the route
match's params.

This update corrects the return type in docs to reflect actual behavior.

Fix #3875
2025-04-01 11:13:23 +13:00
Adam
1f2e243530
docs(start): add note on needing variable export named as APIRoute (#3892)
Just a quick note to prevent hitting 404s where the export needs to be named `APIRoute`.

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-03-31 21:23:31 +13:00
SeanCassiere
ab0173dddb
docs(start): update the list to the router examples 2025-03-30 00:29:39 +13:00
Maradona Morais
f1b2d001fa
docs(router): fix _pathlessLayout example of file-based routing (#3877)
The `_pathlessLayout.tsx` should be the same name as the directory
`_pathlessLayout` in order to be applied as Layout for `route-a` and
`route-b` routes
2025-03-28 18:52:54 +01:00
Neeraj Dalal
3652b3529d
docs(start): switch from degit to gitpick (#3863)
Degit is both slower and has some odd caching behaviour on the user's machine.
Gitpick is faster and conforms to more native github URLs.
2025-03-28 05:09:44 +13:00
Birk Skyum
7155c42e9e
chore(docs): fix escaping of brackets in solid overview page (#3866)
addressing
https://github.com/TanStack/router/pull/3864#discussion_r2015283936
2025-03-27 03:34:58 +01:00
Birk Skyum
739362f1f9
release experimental @tanstack/solid-start package (#3864)
Mentions of this being experimental in
- overview page (first in the docs)
- readme of solid-start package

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-03-27 01:19:57 +01:00
Agus Setya R
6b1f3c163e
fix(docs): Update link for the The Router Configuration: Preloading & Caching (#3833)
There are broken links in the Tanstack Start "Build from Scratch: The
Router Configuration" section.
I believe this should goes into Tanstack Router documentation.
2025-03-26 17:13:53 +01:00
Matthew Sperry
025ef40748
docs: fix create-tsrouter-app command (#3829)
I ran into errors trying to use the npm and yarn commands listed here,
so I looked at https://github.com/TanStack/create-tsrouter-app and it
appears you should use npx with the `--package-manager` option to
specify npm/yarn/etc.

I see the doc was updated in
https://github.com/TanStack/router/pull/3759/files#diff-32b91344fa0565552fb394a3166cbdebd81afa9d02ffec1ed2c1d055ebad46a9,
I assume that was the old way to create a project but feel free to edit
or close this PR if there's a better way to document this, thanks.
2025-03-26 17:12:50 +01:00
SeanCassiere
291667dea9
docs(react-router,solid-router): add missing hash to the faq 2025-03-21 17:05:46 +13:00
Sean Cassiere
bfa90f7403
docs(react-router,solid-router): add a FAQ section (#3822) 2025-03-21 16:50:56 +13:00
Sean Cassiere
906525964d
docs(start): move router configuration note to the top (#3819) 2025-03-21 11:38:26 +13:00
seab
020c4c2d1d
docs: typo fix (#3806) 2025-03-18 21:44:40 +00:00
Daniel
3a0c6dd019
docs(start): fix broken url to the start-counter example (#3795)
Fix wrong url for start-counter example

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-03-18 05:16:08 +13:00
Alex D'Elia
bf5005f17d
docs(react-router): add view transitions example (#3791)
React example showing off view transitions at work.

---

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-03-17 14:25:29 +13:00
Alex Tirim
c1baf7733c
[DOCS] : Fix wrong getting started command (#3788) 2025-03-16 10:41:11 +00:00
James Chung
4568b38b69
docs: typo in the "external-data-loading" guide (#3772) 2025-03-15 18:01:48 +13:00
branko-slavkov
869ec3baa6
docs: Update useBlockerHook.md (#3767) 2025-03-13 23:56:02 +01:00
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