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

index.tsx

345 lines7.2 KB

1'use client'
2​
3export {
4 defer,
5 isMatch,
6 joinPaths,
7 cleanPath,
8 trimPathLeft,
9 trimPathRight,
10 trimPath,
11 resolvePath,
12 interpolatePath,
13 rootRouteId,
14 defaultParseSearch,
15 defaultStringifySearch,
16 parseSearchWith,
17 stringifySearchWith,
18 functionalUpdate,
19 replaceEqualDeep,
20 deepEqual,
21 createControlledPromise,
22 retainSearchParams,
23 stripSearchParams,
24 createSerializationAdapter,
25} from '@tanstack/router-core'
26​
27export type {
28 AnyRoute,
29 DeferredPromiseState,
30 DeferredPromise,
31 ParsedLocation,
32 RemoveTrailingSlashes,
33 RemoveLeadingSlashes,
34 ActiveOptions,
35 ResolveRelativePath,
36 RootRouteId,
37 AnyPathParams,
38 ResolveParams,
39 ResolveOptionalParams,
40 ResolveRequiredParams,
41 SearchSchemaInput,
42 AnyContext,
43 RouteContext,
44 PreloadableObj,
45 RoutePathOptions,
46 StaticDataRouteOption,
47 RoutePathOptionsIntersection,
48 UpdatableStaticRouteOption,
49 MetaDescriptor,
50 RouteLinkEntry,
51 ParseParamsFn,
52 SearchFilter,
53 ResolveId,
54 InferFullSearchSchema,
55 InferFullSearchSchemaInput,
56 ErrorRouteProps,
57 ErrorComponentProps,
58 NotFoundRouteProps,
59 TrimPath,
60 TrimPathLeft,
61 TrimPathRight,
62 StringifyParamsFn,
63 ParamsOptions,
64 InferAllParams,
65 InferAllContext,
66 LooseReturnType,
67 LooseAsyncReturnType,
68 ContextReturnType,
69 ContextAsyncReturnType,
70 ResolveLoaderData,
71 ResolveRouteContext,
72 SearchSerializer,
73 SearchParser,
74 SearchMiddleware,
75 TrailingSlashOption,
76 Manifest,
77 RouterManagedTag,
78 ControlledPromise,
79 Constrain,
80 Expand,
81 MergeAll,
82 Assign,
83 IntersectAssign,
84 ResolveValidatorInput,
85 ResolveValidatorOutput,
86 Register,
87 AnyValidator,
88 DefaultValidator,
89 ValidatorFn,
90 AnySchema,
91 AnyValidatorAdapter,
92 AnyValidatorFn,
93 AnyValidatorObj,
94 ResolveValidatorInputFn,
95 ResolveValidatorOutputFn,
96 ResolveSearchValidatorInput,
97 ResolveSearchValidatorInputFn,
98 Validator,
99 ValidatorAdapter,
100 ValidatorObj,
101 FileRoutesByPath,
102 RouteById,
103 RootRouteOptions,
104 CreateFileRoute,
105 SerializationAdapter,
106 AnySerializationAdapter,
107 SerializableExtensions,
108} from '@tanstack/router-core'
109​
110export {
111 createHistory,
112 createBrowserHistory,
113 createHashHistory,
114 createMemoryHistory,
115} from '@tanstack/history'
116​
117export type {
118 BlockerFn,
119 HistoryLocation,
120 RouterHistory,
121 ParsedPath,
122 HistoryState,
123} from '@tanstack/history'
124​
125export { useAwaited, Await } from './awaited'
126export type { AwaitOptions } from './awaited'
127​
128export { CatchBoundary, ErrorComponent } from './CatchBoundary'
129export { ClientOnly, useHydrated } from './ClientOnly'
130export { reactUse, useLayoutEffect } from './utils'
131​
132export {
133 FileRoute,
134 createFileRoute,
135 FileRouteLoader,
136 LazyRoute,
137 createLazyRoute,
138 createLazyFileRoute,
139} from './fileRoute'
140​
141export * from './history'
142​
143export { lazyRouteComponent } from './lazyRouteComponent'
144​
145export { useLinkProps, createLink, Link, linkOptions } from './link'
146export type {
147 InferDescendantToPaths,
148 RelativeToPath,
149 RelativeToParentPath,
150 RelativeToCurrentPath,
151 AbsoluteToPath,
152 RelativeToPathAutoComplete,
153 NavigateOptions,
154 ToOptions,
155 ToMaskOptions,
156 ToSubOptions,
157 ResolveRoute,
158 SearchParamOptions,
159 PathParamOptions,
160 ToPathOption,
161 LinkOptions,
162 MakeOptionalPathParams,
163 FileRouteTypes,
164 RouteContextParameter,
165 BeforeLoadContextParameter,
166 ResolveAllContext,
167 ResolveAllParamsFromParent,
168 ResolveFullSearchSchema,
169 ResolveFullSearchSchemaInput,
170 RouteIds,
171 NavigateFn,
172 BuildLocationFn,
173 FullSearchSchemaOption,
174 MakeRemountDepsOptionsUnion,
175 RemountDepsOptions,
176 ResolveFullPath,
177 AnyRouteWithContext,
178 AnyRouterWithContext,
179 CommitLocationOptions,
180 MatchLocation,
181 UseNavigateResult,
182 AnyRedirect,
183 Redirect,
184 RedirectOptions,
185 ResolvedRedirect,
186 MakeRouteMatch,
187 MakeRouteMatchUnion,
188 RouteMatch,
189 AnyRouteMatch,
190 RouteContextFn,
191 RouteContextOptions,
192 BeforeLoadContextOptions,
193 ContextOptions,
194 RouteOptions,
195 FileBaseRouteOptions,
196 BaseRouteOptions,
197 UpdatableRouteOptions,
198 RouteLoaderFn,
199 LoaderFnContext,
200 LazyRouteOptions,
201 AnyRouter,
202 RegisteredRouter,
203 RouterContextOptions,
204 ControllablePromise,
205 RouterOptions,
206 RouterState,
207 ListenerFn,
208 BuildNextOptions,
209 RouterConstructorOptions,
210 RouterEvents,
211 RouterEvent,
212 RouterListener,
213 RouteConstraints,
214 RouteMask,
215 MatchRouteOptions,
216 CreateLazyFileRoute,
217} from '@tanstack/router-core'
218export type {
219 UseLinkPropsOptions,
220 ActiveLinkOptions,
221 LinkProps,
222 LinkComponent,
223 LinkComponentProps,
224 CreateLinkProps,
225} from './link'
226​
227export {
228 Matches,
229 useMatchRoute,
230 MatchRoute,
231 useMatches,
232 useParentMatches,
233 useChildMatches,
234} from './Matches'
235​
236export type { UseMatchRouteOptions, MakeMatchRouteOptions } from './Matches'
237​
238export { Match, Outlet } from './Match'
239​
240export { useMatch } from './useMatch'
241export { useLoaderDeps } from './useLoaderDeps'
242export { useLoaderData } from './useLoaderData'
243​
244export {
245 redirect,
246 isRedirect,
247 createRouterConfig,
248 DEFAULT_PROTOCOL_ALLOWLIST,
249} from '@tanstack/router-core'
250​
251export {
252 RouteApi,
253 getRouteApi,
254 Route,
255 createRoute,
256 RootRoute,
257 rootRouteWithContext,
258 createRootRoute,
259 createRootRouteWithContext,
260 createRouteMask,
261 NotFoundRoute,
262} from './route'
263export type {
264 AnyRootRoute,
265 AsyncRouteComponent,
266 RouteComponent,
267 ErrorRouteComponent,
268 NotFoundRouteComponent,
269 DefaultRouteTypes,
270 RouteTypes,
271} from './route'
272​
273export { createRouter, Router } from './router'
274​
275export { lazyFn, SearchParamError } from '@tanstack/router-core'
276​
277export { RouterProvider, RouterContextProvider } from './RouterProvider'
278export type { RouterProps } from './RouterProvider'
279​
280export {
281 useElementScrollRestoration,
282 ScrollRestoration,
283} from './ScrollRestoration'
284​
285export type { UseBlockerOpts, ShouldBlockFn } from './useBlocker'
286export { useBlocker, Block } from './useBlocker'
287​
288export { useNavigate, Navigate } from './useNavigate'
289​
290export { useParams } from './useParams'
291export { useSearch } from './useSearch'
292​
293export { useRouteContext } from './useRouteContext'
294export { useRouter } from './useRouter'
295export { useRouterState } from './useRouterState'
296export { useLocation } from './useLocation'
297export { useCanGoBack } from './useCanGoBack'
298​
299export { CatchNotFound, DefaultGlobalNotFound } from './not-found'
300export { notFound, isNotFound } from '@tanstack/router-core'
301export type { NotFoundError } from '@tanstack/router-core'
302​
303export type {
304 ValidateLinkOptions,
305 InferStructuralSharing,
306 ValidateUseSearchOptions,
307 ValidateUseParamsOptions,
308 ValidateLinkOptionsArray,
309} from './typePrimitives'
310​
311export type {
312 ValidateFromPath,
313 ValidateToPath,
314 ValidateSearch,
315 ValidateParams,
316 InferFrom,
317 InferTo,
318 InferMaskTo,
319 InferMaskFrom,
320 ValidateNavigateOptions,
321 ValidateNavigateOptionsArray,
322 ValidateRedirectOptions,
323 ValidateRedirectOptionsArray,
324 ValidateId,
325 InferStrict,
326 InferShouldThrow,
327 InferSelected,
328 ValidateUseSearchResult,
329 ValidateUseParamsResult,
330 SerializerExtensions,
331 RegisteredSerializableInput,
332 Serializable,
333} from '@tanstack/router-core'
334​
335export { ScriptOnce } from './ScriptOnce'
336export { Asset } from './Asset'
337export { HeadContent } from './HeadContent'
338export { useTags } from './headContentUtils'
339export { Scripts } from './Scripts'
340export type * from './ssr/serializer'
341export { composeRewrites } from '@tanstack/router-core'
342export type {
343 LocationRewrite,
344 LocationRewriteFunction,
345} from '@tanstack/router-core'