Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

useRouteContext.ts

30 lines974 Bytes

1import { useMatch } from './useMatch'
2import type {
3 AnyRouter,
4 RegisteredRouter,
5 UseRouteContextBaseOptions,
6 UseRouteContextOptions,
7 UseRouteContextResult,
8} from '@tanstack/router-core'
9​
10export type UseRouteContextRoute<out TFrom> = <
11 TRouter extends AnyRouter = RegisteredRouter,
12 TSelected = unknown,
13>(
14 opts?: UseRouteContextBaseOptions<TRouter, TFrom, true, TSelected>,
15) => UseRouteContextResult<TRouter, TFrom, true, TSelected>
16​
17export function useRouteContext<
18 TRouter extends AnyRouter = RegisteredRouter,
19 const TFrom extends string | undefined = undefined,
20 TStrict extends boolean = true,
21 TSelected = unknown,
22>(
23 opts: UseRouteContextOptions<TRouter, TFrom, TStrict, TSelected>,
24): UseRouteContextResult<TRouter, TFrom, TStrict, TSelected> {
25 return useMatch({
26 ...(opts as any),
27 select: (match) =>
28 opts.select ? opts.select(match.context) : match.context,
29 }) as UseRouteContextResult<TRouter, TFrom, TStrict, TSelected>