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

app.tsx

385 lines9.4 KB

1import {
2 Link,
3 Outlet,
4 RouterProvider,
5 createMemoryHistory,
6 createRootRoute,
7 createRoute,
8 createRouter,
9 useParams,
10 useSearch,
11} from '@tanstack/react-router'
12import { createRoot } from 'react-dom/client'
13​
14function runPerfSelectorComputation(seed: number) {
15 let value = Math.trunc(seed) | 0
16​
17 for (let index = 0; index < 40; index++) {
18 value = (value * 1664525 + 1013904223 + index) >>> 0
19 }
20​
21 return value
23​
24function normalizePage(value: unknown) {
25 const page = Number(value)
26 return Number.isFinite(page) && page > 0 ? Math.trunc(page) : 1
28​
29function normalizeFilter(value: unknown) {
30 return typeof value === 'string' && value.length > 0 ? value : 'all'
32​
33const noop = () => {}
34const rootSelectors = Array.from({ length: 10 }, (_, index) => index)
35const routeSelectors = Array.from({ length: 6 }, (_, index) => index)
36const linkGroups = Array.from({ length: 4 }, (_, index) => index)
37​
38function RootParamsSubscriber() {
39 const params = useParams({
40 strict: false,
41 select: (params) => runPerfSelectorComputation(Number(params.id ?? 0)),
42 })
43​
44 void runPerfSelectorComputation(params)
45 return null
47​
48function RootSearchSubscriber() {
49 const search = useSearch({
50 strict: false,
51 select: (search) => runPerfSelectorComputation(Number(search.page ?? 0)),
52 })
53​
54 void runPerfSelectorComputation(search)
55 return null
57​
58function LinkPanel() {
59 return (
60 <>
61 {linkGroups.map((groupIndex) => {
62 const itemsId = groupIndex === 0 ? 1 : groupIndex + 2
63 const ctxId = groupIndex + 1
64​
65 return (
66 <div key={groupIndex}>
67 <Link
68 data-testid={groupIndex === 0 ? 'go-items-1' : undefined}
69 to="/items/$id"
70 params={{ id: itemsId }}
71 replace
72 activeOptions={{ exact: true }}
73 activeProps={{ className: 'active-link' }}
74 inactiveProps={{ className: 'inactive-link' }}
75 >
76 {`Items ${itemsId}`}
77 </Link>
78 <Link
79 data-testid={groupIndex === 0 ? 'go-items-2' : undefined}
80 to="/items/$id"
81 params={{ id: 2 }}
82 replace
83 activeOptions={{ includeSearch: false }}
84 >
85 {`Items 2 alt ${groupIndex}`}
86 </Link>
87 <Link
88 data-testid={groupIndex === 0 ? 'go-search' : undefined}
89 to="/search"
90 search={{ page: 1, filter: 'all', junk: `group-${groupIndex}` }}
91 replace
92 activeOptions={{ includeSearch: true }}
93 activeProps={{ className: 'active-link' }}
94 inactiveProps={{ className: 'inactive-link' }}
95 >
96 {`Search ${groupIndex}`}
97 </Link>
98 <Link
99 data-testid={groupIndex === 0 ? 'go-ctx' : undefined}
100 to="/ctx/$id"
101 params={{ id: ctxId }}
102 search={true}
103 replace
104 activeOptions={{ includeSearch: false }}
105 >
106 {`Context ${ctxId}`}
107 </Link>
108 <Link
109 from={searchRoute.fullPath}
110 to="/search"
111 search={(prev: { page: number; filter: string }) => ({
112 page: prev.page + groupIndex + 1,
113 filter: prev.filter,
114 junk: `updater-${groupIndex}`,
115 })}
116 activeOptions={{ includeSearch: true }}
117 >
118 {({ isActive }) =>
119 isActive
120 ? `Search updater active ${groupIndex}`
121 : `Search updater inactive ${groupIndex}`
122 }
123 </Link>
124 </div>
125 )
126 })}
127 </>
128 )
130​
131function Root() {
132 return (
133 <>
134 {rootSelectors.map((selector) => (
135 <RootParamsSubscriber key={`root-params-${selector}`} />
136 ))}
137 {rootSelectors.map((selector) => (
138 <RootSearchSubscriber key={`root-search-${selector}`} />
139 ))}
140 <LinkPanel />
141 <Outlet />
142 </>
143 )
145​
146const rootRoute = createRootRoute({
147 component: Root,
148})
149​
150const itemsRoute = createRoute({
151 getParentRoute: () => rootRoute,
152 path: '/items/$id',
153 params: {
154 parse: (params) => ({
155 ...params,
156 id: normalizePage(params.id),
157 }),
158 stringify: (params) => ({
159 ...params,
160 id: `${params.id}`,
161 }),
162 },
163 onEnter: noop,
164 onStay: noop,
165 onLeave: noop,
166 component: ItemsPage,
167})
168​
169const itemDetailsRoute = createRoute({
170 getParentRoute: () => itemsRoute,
171 path: 'details',
172 component: ItemDetailsPage,
173})
174​
175const searchRoute = createRoute({
176 getParentRoute: () => rootRoute,
177 path: '/search',
178 validateSearch: (search: Record<string, unknown>) => ({
179 page: normalizePage(search.page),
180 filter: normalizeFilter(search.filter),
181 }),
182 search: {
183 middlewares: [
184 ({ search, next }) => {
185 const result = next(search)
186 return {
187 page: result.page,
188 filter: result.filter,
189 }
190 },
191 ],
192 },
193 loaderDeps: ({ search }) => ({
194 page: search.page,
195 filter: search.filter,
196 }),
197 loader: ({ deps }) => ({
198 seed: deps.page * 31 + deps.filter.length,
199 checksum: deps.page * 17 + deps.filter.length,
200 }),
201 staleTime: 60_000,
202 gcTime: 60_000,
203 component: SearchPage,
204})
205​
206const contextRoute = createRoute({
207 getParentRoute: () => rootRoute,
208 path: '/ctx/$id',
209 beforeLoad: ({ params }) => ({
210 sectionSeed: Number(params.id) * 13 + 1,
211 }),
212 component: ContextPage,
213})
214​
215function ItemParamsSubscriber() {
216 const params = itemsRoute.useParams({
217 select: (params) => runPerfSelectorComputation(params.id),
218 })
219​
220 void runPerfSelectorComputation(params)
221 return null
223​
224function SearchStateSubscriber() {
225 const search = searchRoute.useSearch({
226 select: (search) =>
227 runPerfSelectorComputation(search.page + search.filter.length),
228 })
229​
230 void runPerfSelectorComputation(search)
231 return null
233​
234function SearchLoaderDepsSubscriber() {
235 const loaderDeps = searchRoute.useLoaderDeps({
236 select: (loaderDeps) =>
237 runPerfSelectorComputation(loaderDeps.page + loaderDeps.filter.length),
238 })
239​
240 void runPerfSelectorComputation(loaderDeps)
241 return null
243​
244function SearchLoaderDataSubscriber() {
245 const loaderData = searchRoute.useLoaderData({
246 select: (loaderData) =>
247 runPerfSelectorComputation(loaderData.seed + loaderData.checksum),
248 })
249​
250 void runPerfSelectorComputation(loaderData)
251 return null
253​
254function ContextParamsSubscriber() {
255 const params = contextRoute.useParams({
256 select: (params) => runPerfSelectorComputation(Number(params.id)),
257 })
258​
259 void runPerfSelectorComputation(params)
260 return null
262​
263function ContextRouteSubscriber() {
264 const context = contextRoute.useRouteContext({
265 select: (context) => runPerfSelectorComputation(context.sectionSeed),
266 })
267​
268 void runPerfSelectorComputation(context)
269 return null
271​
272function ItemsPage() {
273 return (
274 <>
275 {routeSelectors.map((selector) => (
276 <ItemParamsSubscriber key={`item-params-${selector}`} />
277 ))}
278 <Link
279 data-testid="items-details"
280 from={itemsRoute.fullPath}
281 to="./details"
282 replace
283 >
284 Details
285 </Link>
286 <Link
287 from={itemsRoute.fullPath}
288 to="."
289 search={true}
290 activeOptions={{ includeSearch: true }}
291 >
292 Preserve search on item
293 </Link>
294 <Outlet />
295 </>
296 )
298​
299function ItemDetailsPage() {
300 return (
301 <>
302 {routeSelectors.map((selector) => (
303 <ItemParamsSubscriber key={`detail-params-${selector}`} />
304 ))}
305 <Link
306 data-testid="items-parent"
307 from={itemDetailsRoute.fullPath}
308 to=".."
309 replace
310 activeOptions={{ exact: true }}
311 >
312 Back to item
313 </Link>
314 </>
315 )
317​
318function SearchPage() {
319 return (
320 <>
321 {routeSelectors.map((selector) => (
322 <SearchStateSubscriber key={`search-state-${selector}`} />
323 ))}
324 {routeSelectors.map((selector) => (
325 <SearchLoaderDepsSubscriber key={`search-loader-deps-${selector}`} />
326 ))}
327 {routeSelectors.map((selector) => (
328 <SearchLoaderDataSubscriber key={`search-loader-data-${selector}`} />
329 ))}
330 <Link
331 data-testid="search-next-page"
332 from={searchRoute.fullPath}
333 to="."
334 replace
335 search={(prev: { page: number; filter: string }) => ({
336 page: prev.page + 1,
337 filter: prev.filter,
338 junk: 'local-updater',
339 })}
340 activeOptions={{ includeSearch: true }}
341 activeProps={{ className: 'active-link' }}
342 inactiveProps={{ className: 'inactive-link' }}
343 >
344 Next page
345 </Link>
346 </>
347 )
349​
350function ContextPage() {
351 return (
352 <>
353 {routeSelectors.map((selector) => (
354 <ContextParamsSubscriber key={`context-params-${selector}`} />
355 ))}
356 {routeSelectors.map((selector) => (
357 <ContextRouteSubscriber key={`context-route-${selector}`} />
358 ))}
359 </>
360 )
362​
363export function mountTestApp(container: Element) {
364 const router = createRouter({
365 history: createMemoryHistory({
366 initialEntries: ['/items/0'],
367 }),
368 scrollRestoration: true,
369 routeTree: rootRoute.addChildren([
370 itemsRoute.addChildren([itemDetailsRoute]),
371 searchRoute,
372 contextRoute,
373 ]),
374 })
375​
376 const reactRoot = createRoot(container)
377 reactRoot.render(<RouterProvider router={router} />)
378​
379 return {
380 router,
381 unmount() {
382 reactRoot.unmount()
383 },
384 }