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

916 commits

Author SHA1 Message Date
SeanCassiere
83424d22bb
docs: update build-from-scratch guides 2025-05-09 14:19:31 +12:00
Manuel Schiller
c3e84a85b8 update docs 2025-05-09 00:09:00 +02:00
SeanCassiere
e7569ce2e3
fix conflicts 2025-05-08 08:04:38 +12:00
Tanner Linsley
4d958bae38 docs 2025-05-07 13:56:52 -06:00
Tanner Linsley
cb26724ff2 de-"vinxi" 2025-05-07 13:51:51 -06:00
Andy Kiesler
144a33c48e
docs(router): normalize heading level for "Effect" in search guide (#4100) 2025-05-07 10:56:27 +12:00
SeanCassiere
123bde0636
Merge remote-tracking branch 'origin/main' into devinxi 2025-05-06 10:40:46 +12:00
Miro Rauhala
f0dbf0a124
docs(router): update working in the "route-trees" guide (#4091) 2025-05-06 10:38:59 +12:00
Ilya Komichev
409252e947
docs(start): fix typos in logos (#4090) 2025-05-06 10:15:09 +12:00
Shruti Kapoor
ba8a1c836d
Adding Tutorial for Reading and Writing a File (#4089)
# Add DevJokes Tutorial: Reading and Writing Files
<img width="1318" alt="image"
src="https://github.com/user-attachments/assets/e6284dea-9596-42e5-b37a-c29ed56fa934"
/>

## Description
Adds a tutorial showing how to build a full-stack DevJokes app with
TanStack Start. Users learn to create server functions for reading and
writing to files, build React components, and implement data fetching
with TanStack Router.

## Key Features
- Server functions with `createServerFn`
- File-based data storage with Node.js `fs`
- Form handling and data validation
- Data refreshing with `router.invalidate()`
- Complete UI with Tailwind CSS

## Demo
https://youtu.be/zd0rtKbtlgU

## Reference
Complete code available at: https://github.com/shrutikapoor08/devjokes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-05 08:23:49 -06:00
SeanCassiere
20d7508a0b
Merge remote-tracking branch 'origin/main' into devinxi 2025-05-02 10:28:09 +12:00
Chukwuka Morka
191a1c8a2b
docs(router): walkthrough on using the ignore prefix for component colocation in the routing-concepts guide (#4075)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-05-02 10:17:05 +12:00
Chukwuka Morka
5e08ac5d74
docs(router): add ignore prefix into the file naming conventions guide (#4074)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-05-02 10:16:52 +12:00
Max Zhang
eb649e79de
docs(start): fix typos in the hosting guide (#4073) 2025-05-01 14:26:59 +12:00
SeanCassiere
bdc694d4b8
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-30 22:10:32 +12:00
Ionut-Cristian Florescu
285cff7bbd
docs(start): fix key on changing the base path for API routes (#4062) 2025-04-30 18:35:26 +12:00
Leonardo Montini
413a56a347
docs: fix broken link (#4055) 2025-04-26 21:05:15 +02:00
SeanCassiere
e2e794622d
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-25 19:43:27 +12:00
SeanCassiere
7ab6f5694f
docs(router): update link to create-tsrouter-app options 2025-04-25 19:09:37 +12:00
SeanCassiere
aec638a714
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-25 14:32:27 +12:00
Tanner Linsley
fff694147b
Update overview.md 2025-04-23 15:20:59 -06:00
Tanner Linsley
bbbcb9c6ff
Update overview.md 2025-04-23 13:12:44 -06:00
SeanCassiere
8cb2bbc816
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-23 13:53:35 +12:00
Mikaël Sévigny
431dec2c26
docs(start): remove trailing commas from "build-from-scratch" (#4029)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-04-23 13:22:58 +12:00
Tanner Linsley
d0540a5d56 checkpoint 2025-04-22 16:44:36 -06:00
SeanCassiere
ad85333351
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-20 11:35:16 +12:00
Matthew Pirocchi
d57f9f5cc6
docs(start): complete the server functions - mutation example (#3992)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-04-17 20:13:24 +12:00
M. Fahad Sohail
afbeb9ea16
docs(router): fix broken links on the file-naming-conventions guide (#3998)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-04-17 20:04:46 +12:00
Manuel Schiller
b1da22b412 Merge remote-tracking branch 'origin/main' into HEAD 2025-04-17 09:24:14 +02:00
FatahChan
8085969ae3
docs(router): list "parallel routes" in the comparison (#3995) 2025-04-16 09:31:52 +12:00
Fitim Bytyqi
9a4af7cf91
docs: improves react/solid quick-start docs (#3994)
addition fixes from #3961
2025-04-15 01:38:51 +02:00
Ezekiel Keator
3cba9989d2
docs: correct start server git link (#3991) 2025-04-14 19:55:22 +02:00
Seongbin Kim
112438412c
docs(router): broken link to "SSR" from "Deferred Data Loading" guide (#3984) 2025-04-14 09:11:21 +12:00
Yiwan
d4a4e96b62
docs(router): add comment for vite plugin order (#3986)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-04-14 09:10:42 +12:00
Zac Rosenbauer
f0138f80b0
feat(react-router): Export ClientOnly (#3969)
Exposes the `ClientOnly` component for preventing rendering & hydration
errors.

## Background

When you attempt to prevent content from rendering using something like
`typeof document !== 'undefined'` as that type of conditional will cause
hydration errors.

## API

```tsx
import { ClientOnly, createRoute } from '@tanstack/react-router'
import { Charts, FallbackCharts } from './charts-that-break-server-side-rendering'

const Route = createRoute({
  // ... other route options
  path: '/dashboard',
  component: Dashboard,
})

function Dashboard() {
  return (
    <div>
      <p>Dashboard</p>
      <ClientOnly fallback={<FallbackCharts />}>
        <Charts />
      </ClientOnly>
    </div>
  )
}
```

> [!NOTE]
> This component as is (other than I removed the `children` as a
`function`) in production on [joggr.io](https://joggr.io)

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
Co-authored-by: Ahmed Abdelbaset <A7med3bdulBaset@gmail.com>
Co-authored-by: Birk Skyum <birk.skyum@pm.me>
2025-04-13 10:50:44 +02:00
Tanner Linsley
68b518dc63 checkpoint 2025-04-10 15:23:14 -06:00
SeanCassiere
c1fdc50753
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-10 20:50:24 +12:00
Nick Nisi
f9c343e0b5
chore(examples): add TanStack Start WorkOS example (#3966)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-04-10 20:41:57 +12:00
Fitim Bytyqi
09e87448b5
docs: devtools installation (#3961)
Edits the way devtools are installed
2025-04-08 13:02:00 +02:00
SeanCassiere
0c41d0e960
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-06 20:21:14 +12:00
Marvin ROGER
30c49e1328
fix(router-core): search parsing of + using URLSearchParams (#3894)
Closes #3655

Switch out our `qss` implementation from its manual solution
over to using `URLSearchParams` for handling
encoding/decoding while still retaining the same interface.

---------

Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-04-06 16:23:28 +12:00
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
SeanCassiere
f2ce189e77
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-04 14:23:30 +13:00
TN
37fc7e82df
docs: Update scroll-restoration.md (#3934)
Fix typo
2025-04-04 01:35:41 +02:00
SeanCassiere
25d438b21c
Merge remote-tracking branch 'origin/main' into devinxi 2025-04-03 12:56:30 +13: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
SeanCassiere
eeb6bf3fee
Merge remote-tracking branch 'origin/main' into devinxi 2025-03-31 21:42:08 +13:00