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

useRouterState.tsx

36 lines1.0 KB

1import { useStore } from '@tanstack/solid-store'
2import { useRouter } from './useRouter'
3import type {
4 AnyRouter,
5 RegisteredRouter,
6 RouterState,
7} from '@tanstack/router-core'
8import type { Accessor } from 'solid-js'
9​
10export type UseRouterStateOptions<TRouter extends AnyRouter, TSelected> = {
11 router?: TRouter
12 select?: (state: RouterState<TRouter['routeTree']>) => TSelected
14​
15export type UseRouterStateResult<
16 TRouter extends AnyRouter,
17 TSelected,
18> = unknown extends TSelected ? RouterState<TRouter['routeTree']> : TSelected
19​
20export function useRouterState<
21 TRouter extends AnyRouter = RegisteredRouter,
22 TSelected = unknown,
23>(
24 opts?: UseRouterStateOptions<TRouter, TSelected>,
25): Accessor<UseRouterStateResult<TRouter, TSelected>> {
26 const contextRouter = useRouter<TRouter>({
27 warn: opts?.router === undefined,
28 })
29 const router = opts?.router || contextRouter
30​
31 return useStore(router.__store, (state) => {
32 if (opts?.select) return opts.select(state)
33​
34 return state
35 }) as Accessor<UseRouterStateResult<TRouter, TSelected>>