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

1,006 commits

Author SHA1 Message Date
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
Hazem Tarek Elaswad
9374fac48f
docs: Update RouterOptionsType.md (#4796)
Change a typo in `basepath` property description.
2025-07-27 14:26:32 +02:00
Jaen
e83199310a
feat(react-router): add disableGlobalCatchBoundary option (#4765)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Manuel Schiller <manuel.schiller@caligano.de>
2025-07-26 22:45:20 +02:00
Devon Govett
abad0a1e46
docs(react-router): update custom-link guide for react-aria (#4757)
As of [React Aria Components
v1.11.0](https://react-spectrum.adobe.com/releases/2025-07-22.html), we
now pass through DOM events, so it's no longer necessary to use hooks to
create a custom link component. You can just use `createLink` with the
React Aria component directly.


[Demo](https://stackblitz.com/edit/stackblitz-starters-qc66mmzn?file=src%2FLink.tsx)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-07-26 17:23:40 +02:00
Lachlan Collins
a89408affd
chore: sync TanStack repo changes (#4784)
## 🎯 Changes

- Update Prettier and use experimental CLI
- Update Nx to v21
- Fix bug in test exposed by new prettier version
- Sync issues template

## ✅ Checklist

- [x] I have followed the steps listed in the [Contributing
guide](https://github.com/TanStack/config/blob/main/CONTRIBUTING.md).
- [x] I have tested and linted this code locally.
2025-07-26 21:55:38 +10:00
Tanner Linsley
4f802cf1c0
docs: env vars (#4777)
Add a detailed plan for a new 'How to Use Environment Variables' guide
because it addresses a critical and frequently asked topic that is
currently under-documented.

---

[Open in
Web](https://cursor.com/agents?id=bc-7c882ddb-7215-41c7-9ef1-32f42f212449)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-7c882ddb-7215-41c7-9ef1-32f42f212449)

Learn more about [Background
Agents](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-25 16:50:39 -06:00
autofix-ci[bot]
a8ea2b838c
ci: apply automated fixes 2025-07-25 20:20:55 +00:00
Tanner Linsley
ecfe14bc1f
docs: how-to guide for file-based router testing (#4776)
Add a new how-to guide for testing TanStack Router with file-based
routing to cover specific patterns and challenges.

---

[Open in
Web](https://cursor.com/agents?id=bc-ee0f6db1-18b2-4c3b-b69c-13ea7f849190)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-ee0f6db1-18b2-4c3b-b69c-13ea7f849190)

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

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-25 14:19:51 -06:00
autofix-ci[bot]
1d34e56792
ci: apply automated fixes 2025-07-25 20:12:00 +00:00
Tanner Linsley
94ec310682
docs: more! (#4775)
Add comprehensive authentication, testing, and debugging how-to guides
to enhance documentation.

---

[Open in
Web](https://cursor.com/agents?id=bc-ea21e97d-685a-451f-9700-6955d86ef170)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-ea21e97d-685a-451f-9700-6955d86ef170)

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

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-25 14:10:52 -06:00
autofix-ci[bot]
1cd28688c7
ci: apply automated fixes (attempt 2/3) 2025-07-25 19:16:09 +00:00
autofix-ci[bot]
cb08dd6f6a
ci: apply automated fixes 2025-07-25 19:15:11 +00:00
Tanner Linsley
269625a5a7
docs: Split ui library documentation into guides (#4774)
Split the UI library integration guide into individual how-to guides for
Shadcn/ui, Material-UI, Framer Motion, and Chakra UI.

---

[Open in
Web](https://cursor.com/agents?id=bc-8573175f-c315-4c20-a848-fc2e39ef00eb)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-8573175f-c315-4c20-a848-fc2e39ef00eb)

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

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-25 13:14:06 -06:00
autofix-ci[bot]
4c18a66936
ci: apply automated fixes 2025-07-25 19:04:33 +00:00
Tanner Linsley
d7d9d4e8cc
docs: migrate from react router v6
Add a comprehensive migration guide from React Router v7 to TanStack
Router, addressing feedback to target the latest version.

The original PR #4704 aimed to provide a migration guide from React
Router v6. However, a comment from schiller-manuel questioned why v6 was
targeted instead of v7. This PR updates the scope to focus on React
Router v7, which was released in November 2024 and is the current
version, ensuring the guide is relevant for users migrating from the
latest React Router.

---

[Open in
Web](https://cursor.com/agents?id=bc-035967dd-2396-4ba3-9226-f0bfd1c21f11)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-035967dd-2396-4ba3-9226-f0bfd1c21f11)

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

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-25 13:03:25 -06:00
autofix-ci[bot]
38073cb5e9
ci: apply automated fixes 2025-07-25 18:51:55 +00:00
Tanner Linsley
2703b7fcf0
docs: how-to SSR guide
Add a comprehensive "How to Set Up Server-Side Rendering (SSR)" guide to
provide practical, step-by-step instructions and address feedback from
PR #4703.

The previous PR #4703 aimed to add an SSR setup guide but had concerns
regarding overlap with an existing conceptual SSR guide and specific
technical implementation details (e.g., streaming SSR, Vite config).
This PR addresses those concerns by creating a distinct, practical
"how-to" guide with complete code examples, troubleshooting, and a clear
recommendation for TanStack Start, while ensuring it complements the
existing theoretical guide.

---

[Open in
Web](https://cursor.com/agents?id=bc-8555f196-638f-4bec-90a4-5eac52b5918a)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-8555f196-638f-4bec-90a4-5eac52b5918a)

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

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-25 12:50:56 -06:00
Karthik Appiah
b38c42e753
docs(start): add missing dev dep to build-from-scratch guide (#4758) 2025-07-25 09:07:35 +12:00
Manuel Schiller
3b9128e502
docs: slight correction in automatic code splitting 2025-07-23 20:43:30 +02:00
Lee
68fd70bf8e
docs(router): update types for RouteOptions and RouteMatch (#4754)
Closes #3811

---------

Signed-off-by: leesb971204 <leesb971204@gmail.com>
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-07-23 23:41:22 +12:00
Leonardo Montini
1cd917659b
docs(router): using square brackets for character escaping (#4753) 2025-07-23 12:17:50 +12:00
Justin Mißmahl
d87ca5ecf4
docs: fix incorrect import path in automatic code splitting guide (#4745) 2025-07-22 18:04:23 +02:00
Kamlesh Paul
be1b9e39b3
docs: typo in Server-Routes => Escaped Matching (#4741) 2025-07-22 17:12:30 +02:00