0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-18 19:34:24 +00:00
Commit graph

6,591 commits

Author SHA1 Message Date
Jack Herrington
eedbbba8c8
fix: fixing vibe-rules generation to support CJS exports as well (#4327) 2025-06-06 00:06:01 +02:00
IderAghbal
192ee6246c
fix: export OptionalFetcher and RequiredFetcher types (#4297)
I hit a similar issue to #4001 (ts(2742)) but on pnpm, which requires
exporting the types all the way to the module that gets directly
imported by the application according to
https://github.com/microsoft/TypeScript/issues/47663#issuecomment-1519138189.
This fix resolves this issue.
2025-06-04 18:25:15 +02:00
Erfan Hosseini
d1ed4e1c70
docs: Update preloading.md (#4310) 2025-06-03 21:09:06 +02:00
Diego Rincón
9db424fb5b
docs(router): fix path param name in "data mutation" guide (#4302) 2025-06-03 15:08:01 +12:00
Tanner Linsley
6110bbfd8d release: v1.120.15 v1.120.15 2025-06-03 02:49:07 +00:00
Vianney Carel
492b666cc7
fix(router-core): double decoding in qss (#4300)
Co-authored-by: Vianney Carel <vianney.carel@logfuse.fr>
2025-06-03 14:42:17 +12:00
Tanner Linsley
894274cd39 release: v1.120.14 v1.120.14 2025-06-03 02:38:31 +00:00
Manuel Schiller
b84e5c77bc
fix: make route HMR handling robust against route deletion (#4292) 2025-06-01 18:15:26 +02:00
Tanner Linsley
c0a6050b89 release: v1.120.13 v1.120.13 2025-05-30 15:24:43 +00:00
Thomas Marnet
3f858cb268
fix: scroll to top selectors function (#4281) 2025-05-30 16:49:42 +02:00
Neeraj Dalal
18e24a74a5
docs(start): add project structure to next.js migration guide (#4280) 2025-05-30 23:00:45 +12:00
Neeraj Dalal
dc1d7b9137
docs(start): fix typos in next migration guide (#4276) 2025-05-30 16:12:21 +12:00
Neeraj Dalal
a5208e48b6
docs(start): add migration guide from Next.js (#4260)
Co-authored-by: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-05-30 13:20:46 +12:00
Tanner Linsley
d91e63a23d release: v1.120.12 v1.120.12 2025-05-29 19:30:33 +00:00
Jack Herrington
000b4f385a
chore: support vibe-rules in react-router (#4263)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-29 21:25:27 +02:00
Maxx Coffee
fdf31ff7c3
fix: Fix devtools when using shadowdom (#4212)
Co-authored-by: Joshua Coffee <joshcoffee@gannett.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-29 21:24:47 +02:00
Chung
1f34687713
docs: Update code-splitting.md (#4267)
Fix code-based splitting example.
Change file name from `// src/posts.tsx` to `// src/posts.lazy.tsx`
2025-05-29 08:20:59 +02:00
Matt Anderson
64eb2c1425
docs: Update RouteOptionsType doc to reflect correct Loader opts (#4265) 2025-05-28 22:35:40 +02:00
Tanner Linsley
52f06b46a0 release: v1.120.11 v1.120.11 2025-05-26 22:30:22 +00:00
Matthew Struble
dca754ef8b
fix(react-router): fix custom link type ref inference (#4121)
Custom links created by `createLink` would incorrectly infer `ref`
values for non-intrinsic components (such as those with their own `ref`
prop like the [documented
example](https://tanstack.com/router/latest/docs/framework/react/guide/custom-link#basic-example)),
which would result in the ref being "double-wrapped". That is:

Before:
```typescript
{
  // Effective LinkComponentReactProps<TComp>
  // ...
  ref?: React.Ref<React.Ref<HTMLAnchorElement> | undefined> | undefined
  // notice the ref has been "ref'ed" twice
}
```

After fix:
```typescript
{
  // Effective LinkComponentReactProps<TComp>
  // ...
  ref?: React.Ref<HTMLAnchorElement> | undefined>
}
```

This patch, the equivilant applied directly to `link.d.ts` via `yarn
patch`, has been our workaround and it appears to work well:
<details>
<summary>@tanstack-react-router-npm-1.120.3-f6c72d7c75.patch</summary>

```patch
diff --git a/dist/esm/link.d.ts b/dist/esm/link.d.ts
index f7a4dfc2678f3669ee48b97c22e4c69d2f3ff195..be0adda3bf4302466c3c4b4d73ff6c78474a237f 100644
--- a/dist/esm/link.d.ts
+++ b/dist/esm/link.d.ts
@@ -4,9 +4,9 @@ import { ValidateLinkOptions, ValidateLinkOptionsArray } from './typePrimitives.
 import * as React from 'react';
 export declare function useLinkProps<TRouter extends AnyRouter = RegisteredRouter, const TFrom extends string = string, const TTo extends string | undefined = undefined, const TMaskFrom extends string = TFrom, const TMaskTo extends string = ''>(options: UseLinkPropsOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>, forwardedRef?: React.ForwardedRef<Element>): React.ComponentPropsWithRef<'a'>;
 type UseLinkReactProps<TComp> = TComp extends keyof React.JSX.IntrinsicElements ? React.JSX.IntrinsicElements[TComp] : React.PropsWithoutRef<TComp extends React.ComponentType<infer TProps> ? TProps : never> & React.RefAttributes<TComp extends React.FC<{
-    ref: infer TRef;
+    ref: React.Ref<infer TRef>;
 }> | React.Component<{
-    ref: infer TRef;
+    ref: React.Ref<infer TRef>;
 }> ? TRef : never>;
 export type UseLinkPropsOptions<TRouter extends AnyRouter = RegisteredRouter, TFrom extends RoutePaths<TRouter['routeTree']> | string = string, TTo extends string | undefined = '.', TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom, TMaskTo extends string = '.'> = ActiveLinkOptions<'a', TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & UseLinkReactProps<'a'>;
 export type ActiveLinkOptions<TComp = 'a', TRouter extends AnyRouter = RegisteredRouter, TFrom extends string = string, TTo extends string | undefined = '.', TMaskFrom extends string = TFrom, TMaskTo extends string = '.'> = LinkOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & ActiveLinkOptionProps<TComp>;
```

</details>

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-26 20:20:20 +02:00
Lleyton W Morris
bdea54ddf3
docs(router): add route.tsx in directory vs flat routing guide (#4257)
Co-authored-by: Lleyton Morris <lmorris@nexigen.digital>
2025-05-27 00:03:48 +12:00
Tanner Linsley
790016d141 release: v1.120.10 v1.120.10 2025-05-24 09:16:38 +00:00
Lenz Weber-Tronic
ef01673dc6
fix: handle Symbol properties and non-enumerable properties in replaceEqualDeep (#4237)
Opening this PR for discussion, I'm very open to scope changes.

This PR tackles two problems with `defaultStructuralSharing: true`:

1. symbol properties are not taken into account for "object equality"
and are not copied over when creating a new copy
2. non-enumerable properties are not taken into account for "object
equality" and are not copied over when creating a new copy

Point 1. actually is causing some of our users a headache, see
https://github.com/apollographql/apollo-client/issues/12619 and
https://community.apollographql.com/t/preloadquery-with-tanstack-router-loader/9100
.

Users expect that they're able to pass an object with symbol properties
over from a loader into components, but when having
`defaultStructuralSharing` enabled, from the second object that is
passed over, it creates a copy and strips off symbol properties.
That new object without the expected symbol properties will then crash
our `useReadQuery` hook.

In other words, the first loader call returns
```js
{
    refObject: { toPromise: Function1, [secretSymbol]: ImplementationDetail1 }
}
```
the component receives
```js
{
    refObject: { toPromise: Function1, [secretSymbol]: ImplementationDetail1 }
}
```
and the second loader call returns
```js
{
    refObject: { toPromise: Function2, [secretSymbol]: ImplementationDetail2 }
}
```
but the component receives
```js
{
    refObject: { toPromise: Function2 }
}
```
`toPromise` is a different function, so it goes into the "clone" path,
but skips the `secretSymbol` property.

If we wouldn't have that `toPromise` property on there (and we're
considering removing it!), it would even be worse to debug - users would
always stay on the first `refObject` and never get the second, since
both objects would be considered equal.

On our side, passing these objects from loaders to components is
actually an intended pattern, so this is causing quite a bit of problems
- see this example from our docs (see [Initiating queries outside
React](https://www.apollographql.com/docs/react/data/suspense#initiating-queries-outside-react)):

```ts
import { useLoaderData } from 'react-router-dom';

export function loader() {
  return preloadQuery(GET_DOGS_QUERY);
}

export function RouteComponent() {
  const queryRef = useLoaderData();
  const { data } = useReadQuery(queryRef);

  return (
    // ...
  );
}
```

Problem 2. is purely hypothetical and we haven't encountered it - but it
should probably be handled in some way.

Both of these problems can be handled in two ways:

* take these "special properties" into account for comparisons and copy
them over (my naive approach here would lose the "non-enumerability" of
these properties, more code would be necessary to keep that)
* in `isPlainObject` just return `false` if an object has non-enumerable
or symbol properties. This would opt out of structural sharing for these
objects (which is probably perfectly fine)

I'd be open for either of those solutions, and also for completely
dropping the "non-enumerable" case for simplicity, but I would be very
happy if we could get *something* in to help with symbol properties.
In React Query, these values can be assumed to be serializable JSON, so
the current implementation is perfectly fine, but with client-side
loaders, users can just pass anything, and here it's causing quite the
problem.
Telling our users to situationally turn off structural sharing would be
an educational nightmare.
2025-05-24 11:01:44 +02:00
Tanner Linsley
63c623b169 docs: fix links 2025-05-24 01:37:04 -06:00
Tanner Linsley
0d7dc76b60 release: v1.120.9 v1.120.9 2025-05-23 18:54:28 +00:00
Manuel Schiller
7eba99e328
fix: router.buildLocation use RegisteredRouter (#4242)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-23 20:53:06 +02:00
Tanner Linsley
bd9eb8b3a9 release: v1.120.8 v1.120.8 2025-05-23 17:31:26 +00:00
Manuel Schiller
5663aa601b
fix: proper HMR handling for file routes (#4240)
porting from alpha to main

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-23 19:30:01 +02:00
Tanner Linsley
986fa83e6d release: v1.120.7 v1.120.7 2025-05-22 22:27:14 +00:00
Christopher Horobin
5a8267971d
fix: type errors with skipLibCheck: false (#4233)
fixes #4114
2025-05-23 00:25:53 +02:00
scarf
0d71e044d8
docs(react-router): document migration path for parseParams and stringifyParams (#4216) 2025-05-22 20:08:04 +02:00
autofix-ci[bot]
385c47be5f
ci: apply automated fixes 2025-05-22 18:07:48 +00:00
Joel Tannas
d4321feac1
docs: Fix syntax error in search middleware example (#4223) 2025-05-22 20:06:50 +02:00
Leonardo Montini
72ffeb4d4a
docs: fix neon bullet points and url (#4214)
The markdown list wasn't shown properly and I noticed the signup link
was broken

Before

![image](https://github.com/user-attachments/assets/9efd3f90-3ed1-42af-823a-edb4fdd39770)


After

![image](https://github.com/user-attachments/assets/bc43b4ee-30b4-4eb8-ace2-6cd9ca77c2d9)
2025-05-20 20:44:56 +02:00
Tanner Linsley
dd3d33f567 release: v1.120.6 v1.120.6 2025-05-18 08:07:05 +00:00
Adam Hunter
699194749c
fix(router-devtools-core): adds missing containerElement prop support for TanStackRouterDevtoolsCore (#4126)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-05-18 09:52:39 +02:00
Tanner Linsley
ada2b08226 release: v1.120.5 v1.120.5 2025-05-16 20:36:47 +00:00
Manuel Schiller
7bf23b4b18
fix: head execution (#4189) 2025-05-16 22:33:26 +02:00
Tanner Linsley
13996c6875 release: v1.120.4 v1.120.4 2025-05-16 17:05:45 +00:00
Manuel Schiller
e18b333a60
fix: properly handle sessionStorage not being available for scroll restoration (#4186) 2025-05-16 19:03:16 +02:00
ThaumRystra
fa871a0e8b
docs(router): fix scrollRestorationBehavior option in "scroll-restoration" guide (#4169) 2025-05-16 12:20:48 +12:00
Luis Merino
5d940e2d8b
docs: specify that not found errors are handled by the nearest parent when called within loader (#4164) 2025-05-14 00:26:04 +02:00
Tanner Linsley
38142f4c68 docs: update comparison 2025-05-13 11:53:36 -06:00
Birk Skyum
9f93ce0df0
fix(docs): update src to images on tanstack.com (#4165)
tanstack.com has been updated to use /src instead of /app, which means
these broken asset links has to be updated too
2025-05-13 16:11:53 +02:00
Dane Grant
673a04398b
docs(start): Remove unplanned feature from docs (#4150) 2025-05-12 00:37:47 +02:00
Tanner Linsley
14be184843 release: v1.120.3 v1.20.3-alpha.0 v1.120.3 2025-05-08 21:15:31 +00:00
Christopher Horobin
32511d11c7
perf: improve type checking performance of Route.Link (#4117) 2025-05-08 23:14:15 +02:00
Tanner Linsley
163aaa33f2 release: v1.120.2 v1.120.2 2025-05-06 23:32:39 +00:00
Christopher Horobin
f6be2df066
perf: improve ts perf for Route.Link (#4104) 2025-05-07 01:31:10 +02:00
Andy Kiesler
144a33c48e
docs(router): normalize heading level for "Effect" in search guide (#4100) 2025-05-07 10:56:27 +12:00