Open History to see the last commit
1import {
2 BaseRootRoute,
3 BaseRoute,
4 BaseRouteApi,
5 notFound,
6} from '@tanstack/router-core'
7import { Link } from './link'
8import { useLoaderData } from './useLoaderData'
9import { useLoaderDeps } from './useLoaderDeps'
10import { useParams } from './useParams'
11import { useSearch } from './useSearch'
12import { useNavigate } from './useNavigate'
13import { useMatch } from './useMatch'
14import { useRouteContext } from './useRouteContext'
15import { useRouter } from './useRouter'
16import type {
17 AnyContext,
18 AnyRoute,
19 AnyRouter,
20 ConstrainLiteral,
21 ErrorComponentProps,
22 NotFoundError,
23 NotFoundRouteProps,
24 Register,
25 RegisteredRouter,
26 ResolveFullPath,
27 ResolveId,
28 ResolveParams,
29 RootRoute as RootRouteCore,
30 RootRouteId,
31 RootRouteOptions,
32 RouteConstraints,
33 Route as RouteCore,
34 RouteIds,
35 RouteMask,
36 RouteOptions,
37 RouteTypesById,
38 RouterCore,
39 ToMaskOptions,
40 UseNavigateResult,
41} from '@tanstack/router-core'
42import type { UseLoaderDataRoute } from './useLoaderData'
43import type { UseMatchRoute } from './useMatch'
44import type { UseLoaderDepsRoute } from './useLoaderDeps'
45import type { UseParamsRoute } from './useParams'
46import type { UseSearchRoute } from './useSearch'
47import type * as Solid from 'solid-js'
48import type { UseRouteContextRoute } from './useRouteContext'
49import type { LinkComponentRoute } from './link'
50β
51declare module '@tanstack/router-core' {
52 export interface ErrorBoundaryTypes {
53 error: Error
54 }
55β
56 export interface UpdatableRouteOptionsExtensions {
57 component?: RouteComponent
58 errorComponent?: false | null | undefined | ErrorRouteComponent
59 notFoundComponent?: NotFoundRouteComponent
60 pendingComponent?: RouteComponent
61 }
62β
63 export interface RootRouteOptionsExtensions {
64 shellComponent?: ({
65 children,
66 }: {
67 children: Solid.JSX.Element
68 }) => Solid.JSX.Element
69 }
70β
71 export interface RouteExtensions<
72 in out TId extends string,
73 in out TFullPath extends string,
74 > {
75 useMatch: UseMatchRoute<TId>
76 useRouteContext: UseRouteContextRoute<TId>
77 useSearch: UseSearchRoute<TId>
78 useParams: UseParamsRoute<TId>
79 useLoaderDeps: UseLoaderDepsRoute<TId>
80 useLoaderData: UseLoaderDataRoute<TId>
81 useNavigate: () => UseNavigateResult<TFullPath>
82 Link: LinkComponentRoute<TFullPath>
83 }
84}
85β
86export function getRouteApi<
87 const TId,
88 TRouter extends AnyRouter = RegisteredRouter,
89>(id: ConstrainLiteral<TId, RouteIds<TRouter['routeTree']>>) {
90 return new RouteApi<TId, TRouter>({ id })
91}
92β
93export class RouteApi<
94 TId,
95 TRouter extends AnyRouter = RegisteredRouter,
96> extends BaseRouteApi<TId, TRouter> {
97 /**
98 * @deprecated Use the `getRouteApi` function instead.
99 */
100 constructor({ id }: { id: TId }) {
101 super({ id })
102 }
103β
104 useMatch: UseMatchRoute<TId> = (opts) => {
105 return useMatch({ ...opts, from: this.id } as any) as any
106 }
107β
108 useRouteContext: UseRouteContextRoute<TId> = (opts) => {
109 return useRouteContext({ ...(opts as any), from: this.id })
110 }
111β
112 useSearch: UseSearchRoute<TId> = (opts) => {
113 return useSearch({ ...opts, from: this.id } as any)
114 }
115β
116 useParams: UseParamsRoute<TId> = (opts) => {
117 return useParams({ ...opts, from: this.id } as any)
118 }
119β
120 useLoaderDeps: UseLoaderDepsRoute<TId> = (opts) => {
121 return useLoaderDeps({ ...opts, from: this.id, strict: false } as any)
122 }
123β
124 useLoaderData: UseLoaderDataRoute<TId> = (opts) => {
125 return useLoaderData({ ...opts, from: this.id, strict: false } as any)
126 }
127β
128 useNavigate = (): UseNavigateResult<
129 RouteTypesById<TRouter, TId>['fullPath']
130 > => {
131 const router = useRouter()
132 return useNavigate({ from: router.routesById[this.id as string].fullPath })
133 }
134β
135 notFound = (opts?: NotFoundError) => {
136 return notFound({ routeId: this.id as string, ...opts })
137 }
138β
139 Link: LinkComponentRoute<RouteTypesById<TRouter, TId>['fullPath']> = ((
140 props,
141 ) => {
142 const router = useRouter()
143 const fullPath = router.routesById[this.id as string].fullPath
144 return <Link from={fullPath as never} {...props} />
145 }) as LinkComponentRoute<RouteTypesById<TRouter, TId>['fullPath']>
146}
147β
148export class Route<
149 in out TRegister = unknown,
150 in out TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute,
151 in out TPath extends RouteConstraints['TPath'] = '/',
152 in out TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<
153 TParentRoute,
154 TPath
155 >,
156 in out TCustomId extends RouteConstraints['TCustomId'] = string,
157 in out TId extends RouteConstraints['TId'] = ResolveId<
158 TParentRoute,
159 TCustomId,
160 TPath
161 >,
162 in out TSearchValidator = undefined,
163 in out TParams = ResolveParams<TPath>,
164 in out TRouterContext = AnyContext,
165 in out TRouteContextFn = AnyContext,
166 in out TBeforeLoadFn = AnyContext,
167 in out TLoaderDeps extends Record<string, any> = {},
168 in out TLoaderFn = undefined,
169 in out TChildren = unknown,
170 in out TFileRouteTypes = unknown,
171 in out TSSR = unknown,
172 in out TMiddlewares = unknown,
173 in out THandlers = undefined,
174>
175 extends BaseRoute<
176 TRegister,
177 TParentRoute,
178 TPath,
179 TFullPath,
180 TCustomId,
181 TId,
182 TSearchValidator,
183 TParams,
184 TRouterContext,
185 TRouteContextFn,
186 TBeforeLoadFn,
187 TLoaderDeps,
188 TLoaderFn,
189 TChildren,
190 TFileRouteTypes,
191 TSSR,
192 TMiddlewares,
193 THandlers
194 >
195 implements
196 RouteCore<
197 TRegister,
198 TParentRoute,
199 TPath,
200 TFullPath,
201 TCustomId,
202 TId,
203 TSearchValidator,
204 TParams,
205 TRouterContext,
206 TRouteContextFn,
207 TBeforeLoadFn,
208 TLoaderDeps,
209 TLoaderFn,
210 TChildren,
211 TFileRouteTypes,
212 TSSR,
213 TMiddlewares,
214 THandlers
215 >
216{
217 /**
218 * @deprecated Use the `createRoute` function instead.
219 */
220 constructor(
221 options?: RouteOptions<
222 TRegister,
223 TParentRoute,
224 TId,
225 TCustomId,
226 TFullPath,
227 TPath,
228 TSearchValidator,
229 TParams,
230 TLoaderDeps,
231 TLoaderFn,
232 TRouterContext,
233 TRouteContextFn,
234 TBeforeLoadFn,
235 TSSR,
236 TMiddlewares,
237 THandlers
238 >,
239 ) {
240 super(options)
241 }
242β
243 useMatch: UseMatchRoute<TId> = (opts) => {
244 return useMatch({ ...opts, from: this.id } as any) as any
245 }
246β
247 useRouteContext: UseRouteContextRoute<TId> = (opts?) => {
248 return useRouteContext({ ...(opts as any), from: this.id }) as any
249 }
250β
251 useSearch: UseSearchRoute<TId> = (opts) => {
252 return useSearch({ ...opts, from: this.id } as any)
253 }
254β
255 useParams: UseParamsRoute<TId> = (opts) => {
256 return useParams({ ...opts, from: this.id } as any)
257 }
258β
259 useLoaderDeps: UseLoaderDepsRoute<TId> = (opts) => {
260 return useLoaderDeps({ ...opts, from: this.id } as any)
261 }
262β
263 useLoaderData: UseLoaderDataRoute<TId> = (opts) => {
264 return useLoaderData({ ...opts, from: this.id } as any)
265 }
266β
267 useNavigate = (): UseNavigateResult<TFullPath> => {
268 return useNavigate({ from: this.fullPath })
269 }
270β
271 Link: LinkComponentRoute<TFullPath> = ((props) => {
272 return <Link from={this.fullPath} {...props} />
273 }) as LinkComponentRoute<TFullPath>
274}
275β
276export function createRoute<
277 TRegister = unknown,
278 TParentRoute extends RouteConstraints['TParentRoute'] = AnyRoute,
279 TPath extends RouteConstraints['TPath'] = '/',
280 TFullPath extends RouteConstraints['TFullPath'] = ResolveFullPath<
281 TParentRoute,
282 TPath
283 >,
284 TCustomId extends RouteConstraints['TCustomId'] = string,
285 TId extends RouteConstraints['TId'] = ResolveId<
286 TParentRoute,
287 TCustomId,
288 TPath
289 >,
290 TSearchValidator = undefined,
291 TParams = ResolveParams<TPath>,
292 TRouteContextFn = AnyContext,
293 TBeforeLoadFn = AnyContext,
294 TLoaderDeps extends Record<string, any> = {},
295 TLoaderFn = undefined,
296 TChildren = unknown,
297 TSSR = unknown,
298 THandlers = undefined,
299>(
300 options: RouteOptions<
301 TRegister,
302 TParentRoute,
303 TId,
304 TCustomId,
305 TFullPath,
306 TPath,
307 TSearchValidator,
308 TParams,
309 TLoaderDeps,
310 TLoaderFn,
311 AnyContext,
312 TRouteContextFn,
313 TBeforeLoadFn,
314 TSSR,
315 THandlers
316 >,
317): Route<
318 TRegister,
319 TParentRoute,
320 TPath,
321 TFullPath,
322 TCustomId,
323 TId,
324 TSearchValidator,
325 TParams,
326 AnyContext,
327 TRouteContextFn,
328 TBeforeLoadFn,
329 TLoaderDeps,
330 TLoaderFn,
331 TChildren,
332 unknown,
333 TSSR,
334 THandlers
335> {
336 return new Route<
337 TRegister,
338 TParentRoute,
339 TPath,
340 TFullPath,
341 TCustomId,
342 TId,
343 TSearchValidator,
344 TParams,
345 AnyContext,
346 TRouteContextFn,
347 TBeforeLoadFn,
348 TLoaderDeps,
349 TLoaderFn,
350 TChildren,
351 unknown,
352 TSSR,
353 THandlers
354 >(options)
355}
356β
357export type AnyRootRoute = RootRoute<
358 any,
359 any,
360 any,
361 any,
362 any,
363 any,
364 any,
365 any,
366 any,
367 any
368>
369β
370export function createRootRouteWithContext<TRouterContext extends {}>() {
371 return <
372 TRegister = Register,
373 TRouteContextFn = AnyContext,
374 TBeforeLoadFn = AnyContext,
375 TSearchValidator = undefined,
376 TLoaderDeps extends Record<string, any> = {},
377 TLoaderFn = undefined,
378 TSSR = unknown,
379 THandlers = undefined,
380 >(
381 options?: RootRouteOptions<
382 TRegister,
383 TSearchValidator,
384 TRouterContext,
385 TRouteContextFn,
386 TBeforeLoadFn,
387 TLoaderDeps,
388 TLoaderFn,
389 TSSR,
390 THandlers
391 >,
392 ) => {
393 return createRootRoute<
394 TRegister,
395 TSearchValidator,
396 TRouterContext,
397 TRouteContextFn,
398 TBeforeLoadFn,
399 TLoaderDeps,
400 TLoaderFn,
401 TSSR,
402 THandlers
403 >(options)
404 }
405}
406β
407/**
408 * @deprecated Use the `createRootRouteWithContext` function instead.
409 */
410export const rootRouteWithContext = createRootRouteWithContext
411β
412export class RootRoute<
413 in out TRegister = Register,
414 in out TSearchValidator = undefined,
415 in out TRouterContext = {},
416 in out TRouteContextFn = AnyContext,
417 in out TBeforeLoadFn = AnyContext,
418 in out TLoaderDeps extends Record<string, any> = {},
419 in out TLoaderFn = undefined,
420 in out TChildren = unknown,
421 in out TFileRouteTypes = unknown,
422 in out TSSR = unknown,
423 in out THandlers = undefined,
424>
425 extends BaseRootRoute<
426 TRegister,
427 TSearchValidator,
428 TRouterContext,
429 TRouteContextFn,
430 TBeforeLoadFn,
431 TLoaderDeps,
432 TLoaderFn,
433 TChildren,
434 TFileRouteTypes,
435 TSSR,
436 THandlers
437 >
438 implements
439 RootRouteCore<
440 TRegister,
441 TSearchValidator,
442 TRouterContext,
443 TRouteContextFn,
444 TBeforeLoadFn,
445 TLoaderDeps,
446 TLoaderFn,
447 TChildren,
448 TFileRouteTypes,
449 TSSR,
450 THandlers
451 >
452{
453 /**
454 * @deprecated `RootRoute` is now an internal implementation detail. Use `createRootRoute()` instead.
455 */
456 constructor(
457 options?: RootRouteOptions<
458 TRegister,
459 TSearchValidator,
460 TRouterContext,
461 TRouteContextFn,
462 TBeforeLoadFn,
463 TLoaderDeps,
464 TLoaderFn,
465 TSSR,
466 THandlers
467 >,
468 ) {
469 super(options)
470 }
471β
472 useMatch: UseMatchRoute<RootRouteId> = (opts) => {
473 return useMatch({ ...opts, from: this.id } as any) as any
474 }
475β
476 useRouteContext: UseRouteContextRoute<RootRouteId> = (opts) => {
477 return useRouteContext({ ...(opts as any), from: this.id })
478 }
479β
480 useSearch: UseSearchRoute<RootRouteId> = (opts) => {
481 return useSearch({ ...opts, from: this.id } as any)
482 }
483β
484 useParams: UseParamsRoute<RootRouteId> = (opts) => {
485 return useParams({ ...opts, from: this.id } as any)
486 }
487β
488 useLoaderDeps: UseLoaderDepsRoute<RootRouteId> = (opts) => {
489 return useLoaderDeps({ ...opts, from: this.id } as any)
490 }
491β
492 useLoaderData: UseLoaderDataRoute<RootRouteId> = (opts) => {
493 return useLoaderData({ ...opts, from: this.id } as any)
494 }
495β
496 useNavigate = (): UseNavigateResult<'/'> => {
497 return useNavigate({ from: this.fullPath })
498 }
499β
500 Link: LinkComponentRoute<'/'> = ((props) => {
501 return <Link from={this.fullPath} {...(props as any)} />
502 }) as LinkComponentRoute<'/'>
503}
504β
505export function createRouteMask<
506 TRouteTree extends AnyRoute,
507 TFrom extends string,
508 TTo extends string,
509>(
510 opts: {
511 routeTree: TRouteTree
512 } & ToMaskOptions<RouterCore<TRouteTree, 'never', false>, TFrom, TTo>,
513): RouteMask<TRouteTree> {
514 return opts as any
515}
516β
517export type SolidNode = Solid.JSX.Element
518β
519export interface DefaultRouteTypes<TProps> {
520 component: (props: TProps) => any
521}
522export interface RouteTypes<TProps> extends DefaultRouteTypes<TProps> {}
523β
524export type AsyncRouteComponent<TProps> = RouteTypes<TProps>['component'] & {
525 preload?: () => Promise<void> | undefined
526}
527β
528export type RouteComponent = AsyncRouteComponent<{}>
529β
530export type ErrorRouteComponent = AsyncRouteComponent<ErrorComponentProps>
531β
532export type NotFoundRouteComponent = RouteTypes<NotFoundRouteProps>['component']
533β
534export class NotFoundRoute<
535 TRegister,
536 TParentRoute extends AnyRootRoute,
537 TRouterContext = AnyContext,
538 TRouteContextFn = AnyContext,
539 TBeforeLoadFn = AnyContext,
540 TSearchValidator = undefined,
541 TLoaderDeps extends Record<string, any> = {},
542 TLoaderFn = undefined,
543 TChildren = unknown,
544 TSSR = unknown,
545 THandlers = undefined,
546> extends Route<
547 TRegister,
548 TParentRoute,
549 '/404',
550 '/404',
551 '404',
552 '404',
553 TSearchValidator,
554 {},
555 TRouterContext,
556 TRouteContextFn,
557 TBeforeLoadFn,
558 TLoaderDeps,
559 TLoaderFn,
560 TChildren,
561 TSSR,
562 THandlers
563> {
564 constructor(
565 options: Omit<
566 RouteOptions<
567 TRegister,
568 TParentRoute,
569 string,
570 string,
571 string,
572 string,
573 TSearchValidator,
574 {},
575 TLoaderDeps,
576 TLoaderFn,
577 TRouterContext,
578 TRouteContextFn,
579 TBeforeLoadFn,
580 TSSR,
581 THandlers
582 >,
583 | 'caseSensitive'
584 | 'parseParams'
585 | 'stringifyParams'
586 | 'path'
587 | 'id'
588 | 'params'
589 >,
590 ) {
591 super({
592 ...(options as any),
593 id: '404',
594 })
595 }
596}
597β
598export function createRootRoute<
599 TRegister = Register,
600 TSearchValidator = undefined,
601 TRouterContext = {},
602 TRouteContextFn = AnyContext,
603 TBeforeLoadFn = AnyContext,
604 TLoaderDeps extends Record<string, any> = {},
605 TLoaderFn = undefined,
606 TSSR = unknown,
607 THandlers = undefined,
608>(
609 options?: RootRouteOptions<
610 TRegister,
611 TSearchValidator,
612 TRouterContext,
613 TRouteContextFn,
614 TBeforeLoadFn,
615 TLoaderDeps,
616 TLoaderFn,
617 TSSR,
618 THandlers
619 >,
620): RootRoute<
621 TRegister,
622 TSearchValidator,
623 TRouterContext,
624 TRouteContextFn,
625 TBeforeLoadFn,
626 TLoaderDeps,
627 TLoaderFn,
628 unknown,
629 unknown,
630 TSSR,
631 THandlers
632> {
633 return new RootRoute<
634 TRegister,
635 TSearchValidator,
636 TRouterContext,
637 TRouteContextFn,
638 TBeforeLoadFn,
639 TLoaderDeps,
640 TLoaderFn,
641 unknown,
642 unknown,
643 TSSR,
644 THandlers
645 >(options)
646}