Skip to content

docs: update router example and types #5865

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
Balastrong wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update router example and types #5865

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions examples/react/query-router-search-params/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
},
"dependencies": {
"@tanstack/react-query": "^5.49.0",
"@tanstack/react-router": "^1.43.2",
"@tanstack/react-router": "^1.95.3",
"@tanstack/react-table": "^8.20.6",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
"devDependencies": {
"@faker-js/faker": "^8.4.1",
"@tanstack/router-vite-plugin": "^1.43.1",
"@tanstack/router-vite-plugin": "^1.95.3",
"@rollup/plugin-replace": "^5.0.7",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
Expand Down
26 changes: 17 additions & 9 deletions examples/react/query-router-search-params/src/hooks/useFilters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,30 @@ import {
getRouteApi,
RegisteredRouter,
RouteIds,
useNavigate,
SearchParamOptions,
} from '@tanstack/react-router'
import { cleanEmptyParams } from '../utils/cleanEmptyParams'

export function useFilters<T extends RouteIds<RegisteredRouter['routeTree']>>(
routeId: T
) {
const routeApi = getRouteApi<T>(routeId)
const navigate = useNavigate()
export function useFilters<
TId extends RouteIds<RegisteredRouter['routeTree']>,
TSearchParams extends SearchParamOptions<
RegisteredRouter,
TId,
TId
>['search'],
>(routeId: TId) {
const routeApi = getRouteApi<TId>(routeId)
const navigate = routeApi.useNavigate()
const filters = routeApi.useSearch()

const setFilters = (partialFilters: Partial<typeof filters>) =>
const setFilters = (partialFilters: Partial<TSearchParams>) =>
navigate({
search: prev => cleanEmptyParams({ ...prev, ...partialFilters }),
search: cleanEmptyParams({
...filters,
...partialFilters,
}) as TSearchParams,
})
const resetFilters = () => navigate({ search: {} })
const resetFilters = () => navigate({ search: {} as TSearchParams })

return { filters, setFilters, resetFilters }
}
2 changes: 1 addition & 1 deletion examples/react/query-router-search-params/src/routes/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const Route = createFileRoute('/')({
})

function UsersPage() {
const { filters, resetFilters, setFilters } = useFilters(Route.fullPath)
const { filters, resetFilters, setFilters } = useFilters(Route.id)

const { data } = useQuery({
queryKey: ['users', filters],
Expand Down
Loading
Loading