Skip to content

docs: add info about zod 4 #4823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add info about zod 4 #4823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/router/framework/react/guide/search-params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,31 @@ It might be surprising that when you try to navigate to this route, `search` is

For validation libraries we recommend using adapters which infer the correct `input` and `output` types.

### Zod
### Zod 4

An adapter is provided for [Zod](https://zod.dev/) which will pipe through the correct `input` type and `output` type
> [!WARNING]
> Zod v4.0.6 or higher is required for native TanStack Router support.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"native TanStack Router support" sounds a bit weird.

When using [Zod 4](https://zod.dev/) an adapter is not needed to ensure the correct `input` and `output` types are used for navigation and reading search params. This is possible thanks to `zod` enhanced type inference, which preserves complete type information when using [Standard Schema](https://github.com/standard-schema/standard-schema).

```tsx
import { createFileRoute } from '@tanstack/react-router'
import { z } from 'zod'

const productSearchSchema = z.object({
page: z.number().default(1),
filter: z.string().default(''),
sort: z.enum(['newest', 'oldest', 'price']).default('newest').catch('newest'),
Comment on lines +217 to +218
Copy link
Contributor

@KiwiKilian KiwiKilian Aug 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be great to have a few words on the difference of .default() and .default().catch().

Also, when the default is used already twice, should we recommend the pattern from the search middlewares of using an defaultValues object?

})

export const Route = createFileRoute('/shop/products/')({
validateSearch: productSearchSchema,
})
```

### Zod 3

An adapter is provided for [Zod 3](https://v3.zod.dev/) which will pipe through the correct `input` type and `output` type

```tsx
import { createFileRoute } from '@tanstack/react-router'
Expand Down