Open History to see the last commit
1import { useMatch } from './useMatch'
2import type { Accessor } from 'solid-js'
3import type {
4 AnyRouter,
5 RegisteredRouter,
6 ResolveUseLoaderData,
7 StrictOrFrom,
8 UseLoaderDataResult,
9} from '@tanstack/router-core'
10β
11export interface UseLoaderDataBaseOptions<
12 TRouter extends AnyRouter,
13 TFrom,
14 TStrict extends boolean,
15 TSelected,
16> {
17 select?: (match: ResolveUseLoaderData<TRouter, TFrom, TStrict>) => TSelected
18}
19β
20export type UseLoaderDataOptions<
21 TRouter extends AnyRouter,
22 TFrom extends string | undefined,
23 TStrict extends boolean,
24 TSelected,
25> = StrictOrFrom<TRouter, TFrom, TStrict> &
26 UseLoaderDataBaseOptions<TRouter, TFrom, TStrict, TSelected>
27β
28export type UseLoaderDataRoute<out TId> = <
29 TRouter extends AnyRouter = RegisteredRouter,
30 TSelected = unknown,
31>(
32 opts?: UseLoaderDataBaseOptions<TRouter, TId, true, TSelected>,
33) => Accessor<UseLoaderDataResult<TRouter, TId, true, TSelected>>
34β
35export function useLoaderData<
36 TRouter extends AnyRouter = RegisteredRouter,
37 const TFrom extends string | undefined = undefined,
38 TStrict extends boolean = true,
39 TSelected = unknown,
40>(
41 opts: UseLoaderDataOptions<TRouter, TFrom, TStrict, TSelected>,
42): Accessor<UseLoaderDataResult<TRouter, TFrom, TStrict, TSelected>> {
43 return useMatch({
44 from: opts.from!,
45 strict: opts.strict,
46 select: (match) => {
47 return opts.select ? opts.select(match.loaderData) : match.loaderData
48 },
49 }) as any
50}