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

1,028 commits

Author SHA1 Message Date
Nico Lynzaad
834128ea84
docs: Integration with Esbuild - update title to reflect "Esbuild" (#5112)
The integration with Esbuild page's title is reflecting as Vite.

This PR updates it to reflect as "Esbuild"
2025-09-09 14:34:01 +02:00
Nico Lynzaad
a0e4641728
docs: resolve invalid relative paths (#5111)
paths in "migrate from react location" and "migrate from react-router"
to the installation docs form installing Tanstack router returns 404.

This PR fixes the incorrect relative paths.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated installation guide links in the React migration guides for
TanStack Router to point to the correct “How to Install” page.
* Ensures migration steps reference the right documentation, improving
navigation for users following the guides.
  * No functional or code changes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-09 14:30:57 +02:00
Kilian Finger
d939463e93
docs: fix external data loading path (#5109)
The link to External Data Loading on the [Query
Integration](https://tanstack.com/router/latest/docs/integrations/query)
page currently throws a 404.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Corrected a link in the Router integrations guide to point to the
proper External Data Loading page in the React framework section. This
fixes navigation from that note and ensures readers can access the
referenced guidance without errors. No functional changes to the
product; content remains otherwise unchanged and reduces confusion.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-09 13:32:06 +02:00
Jakob Norlin
6202162dd3
docs: change hydration target to document.body in custom client.tsx for Solid (#5091)
Fixes #5085

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated the Solid framework “Learn the Basics” guide to correct the
client hydration example, targeting the appropriate DOM root.
* Clarifies which element to hydrate, aligning the snippet with current
best practices and reducing confusion for readers.
* Improves copy‑paste reliability of the example for newcomers following
the setup steps.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-05 19:07:19 -05:00
Ian J. MacIntosh
741821b2d2
docs(start): Add Railway instructions (#4910)
I was puzzled why Railway wasn't starting a server, then realized
TanStack Start doesn't define the start command by default
2025-09-04 21:49:49 -05:00
Yağız Yorulmazlar
e83fb3b740
docs: Rename Link Preloading Timeout to Link Preloading Delay (#5082)
The current `Link` component doesn't have `preloadTimeout` prop as
stated in the docs. This PR updates documentation to use the correct
`preloadDelay` prop.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated terminology from “Link Preloading Timeout” to “Link Preloading
Delay” to improve clarity.
* Revised examples to use the preloadDelay option instead of
preloadTimeout.
  * Clarified that the default delay remains 50 ms.
* Ensured consistency across headings, descriptions, and code snippets
to match the current public API.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-04 21:24:27 -05:00
autofix-ci[bot]
df4abd267a
ci: apply automated fixes 2025-09-04 20:26:58 +00:00
Nitin Gupta
f8f47d59aa
Added Prisma as a partner in relevant places (#5086)
Inserted relevant logo files and/or blurbs re: Prisma Postgres in the
relevant places. Please review and edit as you see fit.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- Documentation
- Added a Prisma partner tile to the Partners section, linking to
prisma.io with tracking parameters and logo.
- Introduced a Prisma Postgres subsection in the React databases guide
with dark/light logos, feature highlights (edge-optimized, fits your
stack, web UI, auto-scaling, unikernel isolation), and CTAs; placed
after Neon.
- Added Prisma to the TanStack Start funded partners overview with logo
and description, positioned between Neon and Convex.
  - No functional or API changes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
2025-09-04 14:26:10 -06:00
autofix-ci[bot]
f158256bd4
ci: apply automated fixes 2025-09-03 23:41:01 +00:00
HaydenB
540a2bd8a1
docs: Adding note regarding yarn workspace usage (#5073) 2025-09-04 01:40:11 +02:00
hokkyss
bc5e78f04c
docs(start): environment functions for createIsomorphicFn and envOnly (#4806) 2025-09-03 15:40:25 +12:00
Manuel Schiller
31783149e5 docs: document shellComponent 2025-09-02 20:55:42 +02:00
autofix-ci[bot]
5b5f792e3f
ci: apply automated fixes 2025-09-01 17:29:58 +00:00
Noah Silas
0ee993b09e
docs: Use named component in react quick-start (#5061) 2025-09-01 19:29:04 +02:00
Nico Lynzaad
2df8e52ba0
fix(Relative routing): Default relative routing to current location (#4978)
When using relative routing we have 3 things to consider:

1) Is this relative to the current location? This is specifically
relevant for using `to="."` and `to=".."` in layout routes
2) Is this relative to the rendered route location?
3) Should this be relative to some other route in the tree

We have had a few issues where it hasn't been clear how relative routing
is applied in various scenarios, and where the application differs, for
example `to="."` and `to=".."` was treated differently.

This PR applies the following:
1) when no from path is specified, navigation is done from the current
location, this does not affect absolute paths but makes relative paths
more standardised.
2) other relative navigations require a from location to be specified.

This is achieved by setting Link and useNavigate to default to the
current active location instead of the rendered route location. This
also simplifies the logic in buildLocation as we no longer specifically
cater for `to="."`.

Included in this PR is the required changes to router-core
(buildLocation), react-router and solid-router (Link and useNavigate),
tests for both react-router and solid-router and an update to the docs
to clarify the usage.

This closes #4842

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added active-location hooks, origin-aware navigation helpers,
programmatic Route API for Link generation, browser-history utilities,
optional from origin for Navigate, and route fullPath exposure.

* **Bug Fixes**
* More deterministic relative navigation (., ..) resolution,
preservation of search/params, and runtime warnings for invalid origins.

* **Documentation**
  * Clarified relative-link semantics and updated examples.

* **Tests**
* Vastly expanded end-to-end coverage for relative navigation, masking,
basepath, and trailing-slash permutations.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-26 19:30:31 +02:00
Cory House
40f9ab7157
Refine wording in external data loading guide (#5015) 2025-08-23 08:01:54 +02:00
Lee
055ba50212
docs(router): update NotFoundError type (#4866)
- Mark the `global` property of `NotFoundError` as deprecated
- Add a description for `headers`
- Sort the properties in order

Signed-off-by: leesb971204 <leesb971204@gmail.com>
2025-08-13 16:19:14 +12:00
Piotr Kuczynski
ffec133383
docs(eslint): resolve conflict with typescript-eslint/only-throw-error rule (#4934)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-08-13 13:58:04 +12:00
alexgaudon
cb895ff86c
docs: Fix grammar and improve clarity in routeTree.gen.ts FAQ. (#4922) 2025-08-11 20:17:15 +02:00
Flo
916253ad2d
refactor(router-core): Reduce navigation work by making some properties non-reactive (#4916)
Some of the properties of a route match in the store do not need to be
reactive (i.e. reactive = trigger the execution of all subscribers when
they change).

This PR proposes we add a `_nonReactive` key for storing these
properties.

Changes to properties in `_nonReactive` can be made like on a regular
object, without the need to call `__store.setState`, and without making
a shallow copy of the object.

The following properties were moved to `_nonReactive` (but more would be
welcome if we can find which ones):
- `beforeLoadPromise`
- `loaderPromise`
- `pendingTimeout`
- `loadPromise`
- `displayPendingPromise`
- `minPendingPromise`
- `dehydrated`

This results in the removal of 4 `updateMatch` calls in `router-core`.
At least 1 of which is in the hot-path of a navigation (`loadMatches` >
`validResolvedMatches.forEach`). And the removal of 2 `updateMatch`
calls in `packages/react-router/src/Match.tsx` (and solid-router too).

The `ssr` property was also updated to not be reactive, but kept outside
of `_nonReactive` because it is part of the public API. This removes
another call to `updateMatch`. This key is an exception, and if in the
future we find a need to have more "public but non-reactive" properties,
we could consider
- hiding internal props in a separate type, or
- adding a dev proxy to ensure non-reactive props aren't accessed inside
`select` functions

---

This PR adds a unit-test in `react-router` that counts how many times
the `select` inside a `useRouterState` hook is called during a
navigation. Without this PR, the result of this test is **26 calls**.
With this PR, we're down to **19 calls**.

---

Should be a partial improvement of
https://github.com/TanStack/router/issues/4359

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-11 13:59:36 +02:00
Abdullah Al-taheri
fe43f1bf53
docs: Update static-prerendering.md (#4903)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-11 01:53:44 +02:00
Adam Rackis
3023706938
Update getting-started.md (#4909)
Add TanStack Start CLI option
2025-08-10 09:14:53 -07:00
Lee
238c63f36d
docs(router): update links in how-to guides (#4878) 2025-08-09 00:46:51 +02:00
Manuel Schiller
90adfe919e
feat: restructure query-integration (#4643)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-08 23:52:29 +02:00
Diogo Lessa
8efac91d6d
docs(router): fix typo in overview.md (#4863) 2025-08-03 20:37:07 +02:00
Adam Bouqdib
75615f3994
docs(start): fix cloudflare-workers deployment using wrangler.toml (#4779) 2025-08-02 13:07:49 +12:00
Chris
7c6b5752ea
refactor(router-core,start-server-core): improve JSDocs for redirect (#4848)
Co-authored-by: Christopher Menendez <chris@Christophers-MacBook-Pro.local>
2025-08-01 20:13:06 +12:00
Chris
d5fd30f98a
docs(router): update URL for Query (#4849)
Co-authored-by: Christopher Menendez <chris@Christophers-MacBook-Pro.local>
2025-08-01 20:12:50 +12:00
Nico Lynzaad
cb0478a2a8
docs(router): usage of "." and ".." for relative navigation (#4846) 2025-08-01 20:12:42 +12:00
Lee
3ca2a293b2
docs(router): usage of routeFilePrefix for file-based routing (#4845) 2025-08-01 20:12:30 +12:00
Dimitris Karagiannis
f3a594794a
docs(router): list preload as navigation cause value (#4825) 2025-08-01 20:12:21 +12:00
Matthew Hart
87d4ccb67c
docs(start): incorrect usage of scripts in the "document head management" guide (#4801) 2025-08-01 19:58:10 +12:00
autofix-ci[bot]
14ad18f3db
ci: apply automated fixes 2025-07-30 17:10:04 +00:00
Tanner Linsley
bf12ba8e3e
docs: search param sharing/inheritance how-to
Add 'Share Search Parameters Across Routes' how-to guide to complete the
next step in the Progressive Search Params Series.

---
<a
href="https://cursor.com/background-agent?bcId=bc-b62364d8-aa89-47bd-a3f5-d8724879c0ca">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-cursor-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-cursor-light.svg">
<img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg">
  </picture>
</a>
<a
href="https://cursor.com/agents?id=bc-b62364d8-aa89-47bd-a3f5-d8724879c0ca">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-web-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-web-light.svg">
    <img alt="Open in Web" src="https://cursor.com/open-in-web.svg">
  </picture>
</a>

<sub>[Learn
more](https://docs.cursor.com/background-agent/web-and-mobile) about
Cursor Agents</sub>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-30 11:09:18 -06:00
Sean Cassiere
7f290adb41
docs: add frontmatter to the "how-to" guides (#4835) 2025-07-30 20:04:05 +12:00
Lee
127944f042
docs: update links authentication setup guides (#4834) 2025-07-30 19:52:53 +12:00
autofix-ci[bot]
87a730ba5a
ci: apply automated fixes 2025-07-29 17:57:14 +00:00
Tanner Linsley
b402bbc8ca
docs: isomorphic and environment aware code
Add foundational how-to guide on writing isomorphic, client-only, and
server-only code to clarify execution boundaries in TanStack Start.

---
<a
href="https://cursor.com/background-agent?bcId=bc-164a09a2-5b83-4a4a-b6ed-22e447950438">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-cursor-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-cursor-light.svg">
<img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg">
  </picture>
</a>
<a
href="https://cursor.com/agents?id=bc-164a09a2-5b83-4a4a-b6ed-22e447950438">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-web-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-web-light.svg">
    <img alt="Open in Web" src="https://cursor.com/open-in-web.svg">
  </picture>
</a>

<sub>[Learn
more](https://docs.cursor.com/background-agent/web-and-mobile) about
Cursor Agents</sub>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-29 11:55:46 -06:00
autofix-ci[bot]
bff3ad651d
ci: apply automated fixes 2025-07-29 00:50:17 +00:00
Tanner Linsley
c88c2aebae
docs: Outline top how-to guides for TanStack Start (#4816)
Create a detailed plan for TanStack Start how-to guides, prioritizing
based on user issues and dependencies.

This plan outlines over 20 new how-to guides, organized by logical
dependencies and explicitly addressing common pain points found in
GitHub issues, particularly around server functions and deployment.

---

[Open in
Web](https://cursor.com/agents?id=bc-58c1c95a-be49-4ad5-8bd7-80ad78fbc4e7)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-58c1c95a-be49-4ad5-8bd7-80ad78fbc4e7)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-28 18:49:29 -06:00
Tanner Linsley
9c5f6b2e52
docs: Continue search parameter how-tos (#4815)
Add 'Handle Complex Search Parameter Types' guide to continue the search
parameter how-to series.

---

[Open in
Web](https://cursor.com/agents?id=bc-3a8921a5-5923-498f-8d11-5573ae15a43f)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-3a8921a5-5923-498f-8d11-5573ae15a43f)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-07-28 18:45:00 -06:00
autofix-ci[bot]
b5a7bffea4
ci: apply automated fixes 2025-07-28 22:17:46 +00:00
Tanner Linsley
da2bd32eee
docs: Continue search param how-tos (#4814)
Add 'Validate Search Parameters with Schemas' how-to guide and update
related documentation.

---

[Open in
Web](https://cursor.com/agents?id=bc-d5e46bba-1af4-4db9-8631-541879529bf0)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-d5e46bba-1af4-4db9-8631-541879529bf0)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-28 16:16:59 -06:00
autofix-ci[bot]
ed49c81ac9
ci: apply automated fixes 2025-07-28 21:18:42 +00:00
Tanner Linsley
8b53a9a177
docs: basic search params how-to
Add 'Navigate with Search Parameters' how-to guide covering various
navigation methods for search parameters.

This guide details how to update and manage search parameters using both
Link components and programmatic navigation (`useNavigate`, router
instance). It covers basic and functional updates, navigation with route
changes, advanced patterns like conditional navigation and validation,
common UI patterns (search results, filters, breadcrumbs), and addresses
common problems like losing parameters or serialization issues.

---

[Open in
Web](https://cursor.com/agents?id=bc-38c6eb35-f409-43fc-ac4c-323097fb478b)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-38c6eb35-f409-43fc-ac4c-323097fb478b)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-28 15:17:57 -06:00
autofix-ci[bot]
4a1edf695a
ci: apply automated fixes 2025-07-28 20:20:39 +00:00
Tanner Linsley
21300374f6
docs: basic search params how-to
Adds the initial 'Set Up Basic Search Parameters' how-to guide,
recommending any standard schema-compliant validation library, and
updates documentation plans.

---

[Open in
Web](https://cursor.com/agents?id=bc-795e5be2-bf8c-4433-8e6d-72a98fb30a1d)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-795e5be2-bf8c-4433-8e6d-72a98fb30a1d)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-28 14:19:43 -06:00
Tanner Linsley
71c95e6c8f docs: updates 2025-07-28 13:17:35 -06:00
autofix-ci[bot]
de11338d8c
ci: apply automated fixes 2025-07-27 17:15:24 +00:00
notKamui
a08b600b66
docs: Runtime env docs (#4797)
With discussions with @schiller-manuel and the amount of time this issue
has been brought up on Discord, I feel adding precisions and more
explicit examples on how to deal with runtime env variables on the
client could help.

---------

Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
2025-07-27 11:14:40 -06:00