Open History to see the last commit
1import React from 'react'
2import ReactDOM from 'react-dom/client'
3import {
4 ErrorComponent,
5 Link,
6 Outlet,
7 RouterProvider,
8 createRootRouteWithContext,
9 createRoute,
10 createRouter,
11 useRouter,
12} from '@tanstack/react-router'
13import { TanStackRouterDevtools } from '@tanstack/router-devtools'
14import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
15import {
16 QueryClient,
17 QueryClientProvider,
18 queryOptions,
19 useQueryErrorResetBoundary,
20 useSuspenseQuery,
21} from '@tanstack/react-query'
22import axios from 'redaxios'
23import type { ErrorComponentProps } from '@tanstack/react-router'
24β
25type PostType = {
26 id: string
27 title: string
28 body: string
29}
30β
31const fetchPosts = async () => {
32 console.info('Fetching posts...')
33 await new Promise((r) => setTimeout(r, 500))
34 return axios
35 .get<Array<PostType>>('https://jsonplaceholder.typicode.com/posts')
36 .then((r) => r.data.slice(0, 10))
37}
38β
39const fetchPost = async (postId: string) => {
40 console.info(`Fetching post with id ${postId}...`)
41 await new Promise((r) => setTimeout(r, 500))
42 const post = await axios
43 .get<PostType>(`https://jsonplaceholder.typicode.com/posts/${postId}`)
44 .then((r) => r.data)
45β
46 // eslint-disable-next-line ts/no-unnecessary-condition
47 if (!post) {
48 throw new NotFoundError(`Post with id "${postId}" not found!`)
49 }
50β
51 return post
52}
53β
54const rootRoute = createRootRouteWithContext<{
55 queryClient: QueryClient
56}>()({
57 component: RootComponent,
58 notFoundComponent: () => {
59 return <p>This is the notFoundComponent configured on root route</p>
60 },
61})
62β
63function RootComponent() {
64 return (
65 <>
66 <div className="p-2 flex gap-2 text-lg">
67 <Link
68 to="/"
69 activeProps={{
70 className: 'font-bold',
71 }}
72 activeOptions={{ exact: true }}
73 >
74 Home
75 </Link>{' '}
76 <Link
77 to={'/posts'}
78 activeProps={{
79 className: 'font-bold',
80 }}
81 >
82 Posts
83 </Link>{' '}
84 <Link
85 // @ts-expect-error
86 to="/this-route-does-not-exist"
87 activeProps={{
88 className: 'font-bold',
89 }}
90 >
91 This Route Does Not Exist
92 </Link>
93 </div>
94 <hr />
95 <Outlet />
96 <ReactQueryDevtools buttonPosition="top-right" />
97 <TanStackRouterDevtools position="bottom-right" />
98 </>
99 )
100}
101β
102const indexRoute = createRoute({
103 getParentRoute: () => rootRoute,
104 path: '/',
105 component: IndexRouteComponent,
106})
107β
108function IndexRouteComponent() {
109 return (
110 <div className="p-2">
111 <h3>Welcome Home!</h3>
112 </div>
113 )
114}
115β
116const postsQueryOptions = queryOptions({
117 queryKey: ['posts'],
118 queryFn: () => fetchPosts(),
119})
120β
121const postsRoute = createRoute({
122 getParentRoute: () => rootRoute,
123 path: 'posts',
124 loader: ({ context: { queryClient } }) =>
125 queryClient.ensureQueryData(postsQueryOptions),
126 component: PostsRouteComponent,
127})
128β
129function PostsRouteComponent() {
130 const postsQuery = useSuspenseQuery(postsQueryOptions)
131β
132 const posts = postsQuery.data
133β
134 return (
135 <div className="p-2 flex gap-2">
136 <ul className="list-disc pl-4">
137 {[...posts, { id: 'i-do-not-exist', title: 'Non-existent Post' }].map(
138 (post) => {
139 return (
140 <li key={post.id} className="whitespace-nowrap">
141 <Link
142 to={postRoute.to}
143 params={{
144 postId: post.id,
145 }}
146 className="block py-1 text-blue-600 hover:opacity-75"
147 activeProps={{ className: 'font-bold underline' }}
148 >
149 <div>{post.title.substring(0, 20)}</div>
150 </Link>
151 </li>
152 )
153 },
154 )}
155 </ul>
156 <hr />
157 <Outlet />
158 </div>
159 )
160}
161β
162const postsIndexRoute = createRoute({
163 getParentRoute: () => postsRoute,
164 path: '/',
165 component: PostsIndexRouteComponent,
166})
167β
168function PostsIndexRouteComponent() {
169 return <div>Select a post.</div>
170}
171β
172class NotFoundError extends Error {}
173β
174const postQueryOptions = (postId: string) =>
175 queryOptions({
176 queryKey: ['posts', { postId }],
177 queryFn: () => fetchPost(postId),
178 })
179β
180const postRoute = createRoute({
181 getParentRoute: () => postsRoute,
182 path: '$postId',
183 errorComponent: PostErrorComponent,
184 loader: ({ context: { queryClient }, params: { postId } }) =>
185 queryClient.ensureQueryData(postQueryOptions(postId)),
186 component: PostRouteComponent,
187})
188β
189function PostErrorComponent({ error, reset }: ErrorComponentProps) {
190 const router = useRouter()
191 if (error instanceof NotFoundError) {
192 return <div>{error.message}</div>
193 }
194 const queryErrorResetBoundary = useQueryErrorResetBoundary()
195β
196 React.useEffect(() => {
197 queryErrorResetBoundary.reset()
198 }, [queryErrorResetBoundary])
199β
200 return (
201 <div>
202 <button
203 onClick={() => {
204 router.invalidate()
205 }}
206 >
207 retry
208 </button>
209 <ErrorComponent error={error} />
210 </div>
211 )
212}
213β
214function PostRouteComponent() {
215 const { postId } = postRoute.useParams()
216 const postQuery = useSuspenseQuery(postQueryOptions(postId))
217 const post = postQuery.data
218β
219 return (
220 <div className="space-y-2">
221 <h4 className="text-xl font-bold underline">{post.title}</h4>
222 <div className="text-sm">{post.body}</div>
223 </div>
224 )
225}
226β
227const routeTree = rootRoute.addChildren([
228 postsRoute.addChildren([postRoute, postsIndexRoute]),
229 indexRoute,
230])
231β
232const queryClient = new QueryClient()
233β
234// Set up a Router instance
235const router = createRouter({
236 routeTree,
237 defaultPreload: 'intent',
238 // Since we're using React Query, we don't want loader calls to ever be stale
239 // This will ensure that the loader is always called when the route is preloaded or visited
240 defaultPreloadStaleTime: 0,
241 context: {
242 queryClient,
243 },
244})
245β
246// Register things for typesafety
247declare module '@tanstack/react-router' {
248 interface Register {
249 router: typeof router
250 }
251}
252β
253const rootElement = document.getElementById('app')!
254β
255if (!rootElement.innerHTML) {
256 const root = ReactDOM.createRoot(rootElement)
257β
258 root.render(
259 <QueryClientProvider client={queryClient}>
260 <RouterProvider router={router} />
261 </QueryClientProvider>,
262 )
263}