Open History to see the last commit
1import { isServer } from '@tanstack/router-core/isServer'
2import * as Solid from 'solid-js'
3import { replaceEqualDeep } from '@tanstack/router-core'
4import { useRouter } from './useRouter'
5import type {
6 AnyRouter,
7 RegisteredRouter,
8 RouterState,
9} from '@tanstack/router-core'
10import type { Accessor } from 'solid-js'
11β
12export type UseRouterStateOptions<TRouter extends AnyRouter, TSelected> = {
13 router?: TRouter
14 select?: (state: RouterState<TRouter['routeTree']>) => TSelected
15}
16β
17export type UseRouterStateResult<
18 TRouter extends AnyRouter,
19 TSelected,
20> = unknown extends TSelected ? RouterState<TRouter['routeTree']> : TSelected
21β
22export function useRouterState<
23 TRouter extends AnyRouter = RegisteredRouter,
24 TSelected = unknown,
25>(
26 opts?: UseRouterStateOptions<TRouter, TSelected>,
27): Accessor<UseRouterStateResult<TRouter, TSelected>> {
28 const contextRouter = useRouter<TRouter>({
29 warn: opts?.router === undefined,
30 })
31 const router = opts?.router || contextRouter
32β
33 // During SSR we render exactly once and do not need reactivity.
34 // Avoid subscribing to the store on the server since the server store
35 // implementation does not provide subscribe() semantics.
36 // The expression must stay inlined in the `if` so bundlers fold the
37 // browser-build constant `isServer = false` and drop this server block.
38 if (isServer ?? router.isServer) {
39 const state = router.stores.__store.get() as RouterState<
40 TRouter['routeTree']
41 >
42 const selected = (
43 opts?.select ? opts.select(state) : state
44 ) as UseRouterStateResult<TRouter, TSelected>
45 return (() => selected) as Accessor<
46 UseRouterStateResult<TRouter, TSelected>
47 >
48 }
49β
50 if (!opts?.select) {
51 return (() => router.stores.__store.get()) as Accessor<
52 UseRouterStateResult<TRouter, TSelected>
53 >
54 }
55β
56 const select = opts.select
57β
58 return Solid.createMemo((prev: TSelected | undefined) => {
59 const res = select(router.stores.__store.get())
60 if (prev === undefined) return res
61 return replaceEqualDeep(prev, res)
62 }) as Accessor<UseRouterStateResult<TRouter, TSelected>>
63}