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

useLocation.tsx

43 lines1.2 KB

1import * as Solid from 'solid-js'
2import { replaceEqualDeep } from '@tanstack/router-core'
3import { useRouter } from './useRouter'
4import type {
5 AnyRouter,
6 RegisteredRouter,
7 RouterState,
8} from '@tanstack/router-core'
9import type { Accessor } from 'solid-js'
10​
11export interface UseLocationBaseOptions<TRouter extends AnyRouter, TSelected> {
12 select?: (state: RouterState<TRouter['routeTree']>['location']) => TSelected
14​
15export type UseLocationResult<
16 TRouter extends AnyRouter,
17 TSelected,
18> = unknown extends TSelected
19 ? RouterState<TRouter['routeTree']>['location']
20 : TSelected
21​
22export function useLocation<
23 TRouter extends AnyRouter = RegisteredRouter,
24 TSelected = unknown,
25>(
26 opts?: UseLocationBaseOptions<TRouter, TSelected>,
27): Accessor<UseLocationResult<TRouter, TSelected>> {
28 const router = useRouter<TRouter>()
29​
30 if (!opts?.select) {
31 return (() => router.stores.location.get()) as Accessor<
32 UseLocationResult<TRouter, TSelected>
33 >
34 }
35​
36 const select = opts.select
37​
38 return Solid.createMemo((prev: TSelected | undefined) => {
39 const res = select(router.stores.location.get())
40 if (prev === undefined) return res
41 return replaceEqualDeep(prev, res)
42 }) as Accessor<UseLocationResult<TRouter, TSelected>>