Open History to see the last commit
1import { render } from 'solid-js/web'
2import {
3 ErrorComponent,
4 HeadContent,
5 Link,
6 Outlet,
7 RouterProvider,
8 createRootRouteWithContext,
9 createRoute,
10 createRouter,
11 useRouter,
12} from '@tanstack/solid-router'
13import { TanStackRouterDevtools } from '@tanstack/solid-router-devtools'
14import { SolidQueryDevtools } from '@tanstack/solid-query-devtools'
15import {
16 QueryClient,
17 QueryClientProvider,
18 useQuery,
19} from '@tanstack/solid-query'
20import { createEffect, createMemo } from 'solid-js'
21import { NotFoundError, postQueryOptions, postsQueryOptions } from './posts'
22import type { ErrorComponentProps } from '@tanstack/solid-router'
23import './styles.css'
24β
25const rootRoute = createRootRouteWithContext<{
26 queryClient: QueryClient
27}>()({
28 component: RootComponent,
29 notFoundComponent: () => {
30 return (
31 <div>
32 <p>This is the notFoundComponent configured on root route</p>
33 <Link to="/">Start Over</Link>
34 </div>
35 )
36 },
37})
38β
39function RootComponent() {
40 return (
41 <>
42 <HeadContent />
43 <div class="p-2 flex gap-2 text-lg">
44 <Link
45 to="/"
46 activeProps={{
47 class: 'font-bold',
48 }}
49 activeOptions={{ exact: true }}
50 >
51 Home
52 </Link>{' '}
53 <Link
54 to="/posts"
55 activeProps={{
56 class: 'font-bold',
57 }}
58 >
59 Posts
60 </Link>{' '}
61 <Link
62 to="/layout-a"
63 activeProps={{
64 class: 'font-bold',
65 }}
66 >
67 Layout
68 </Link>{' '}
69 <Link
70 // @ts-expect-error
71 to="/this-route-does-not-exist"
72 activeProps={{
73 class: 'font-bold',
74 }}
75 >
76 This Route Does Not Exist
77 </Link>
78 </div>
79 <hr />
80 <Outlet />
81 <SolidQueryDevtools buttonPosition="top-right" />
82 <TanStackRouterDevtools position="bottom-right" />
83 </>
84 )
85}
86β
87const indexRoute = createRoute({
88 getParentRoute: () => rootRoute,
89 path: '/',
90 component: IndexRouteComponent,
91})
92β
93function IndexRouteComponent() {
94 return (
95 <div class="p-2">
96 <h3>Welcome Home!</h3>
97 </div>
98 )
99}
100β
101const postsRoute = createRoute({
102 getParentRoute: () => rootRoute,
103 path: 'posts',
104 loader: ({ context: { queryClient } }) =>
105 queryClient.ensureQueryData(postsQueryOptions),
106}).lazy(() => import('./posts.lazy').then((d) => d.Route))
107β
108const postsIndexRoute = createRoute({
109 getParentRoute: () => postsRoute,
110 path: '/',
111 component: PostsIndexRouteComponent,
112})
113β
114function PostsIndexRouteComponent() {
115 return <div>Select a post.</div>
116}
117β
118function PostErrorComponent({ error, reset }: ErrorComponentProps) {
119 const router = useRouter()
120 if (error instanceof NotFoundError) {
121 return <div>{error.message}</div>
122 }
123 createEffect(() => {
124 reset()
125 queryClient.resetQueries()
126 })
127β
128 return (
129 <div>
130 <button
131 onClick={() => {
132 router.invalidate()
133 }}
134 >
135 retry
136 </button>
137 <ErrorComponent error={error} />
138 </div>
139 )
140}
141β
142const postRoute = createRoute({
143 getParentRoute: () => postsRoute,
144 path: '$postId',
145 errorComponent: PostErrorComponent,
146 loader: ({ context: { queryClient }, params: { postId } }) =>
147 queryClient.ensureQueryData(postQueryOptions(postId)),
148 component: PostRouteComponent,
149})
150β
151function PostRouteComponent() {
152 const params = postRoute.useParams()
153 const postQuery = useQuery(() => postQueryOptions(params().postId))
154 const post = createMemo(() => postQuery.data)
155β
156 return (
157 <div class="space-y-2">
158 <h4 class="text-xl font-bold underline">{post()?.title}</h4>
159 <div class="text-sm">{post()?.body}</div>
160 </div>
161 )
162}
163β
164const layoutRoute = createRoute({
165 getParentRoute: () => rootRoute,
166 id: '_layout',
167 component: LayoutComponent,
168})
169β
170function LayoutComponent() {
171 return (
172 <div class="p-2">
173 <div class="border-b">I'm a layout</div>
174 <div>
175 <Outlet />
176 </div>
177 </div>
178 )
179}
180β
181const layout2Route = createRoute({
182 getParentRoute: () => layoutRoute,
183 id: '_layout-2',
184 component: Layout2Component,
185})
186β
187function Layout2Component() {
188 return (
189 <div>
190 <div>I'm a nested layout</div>
191 <div class="flex gap-2 border-b">
192 <Link
193 to="/layout-a"
194 activeProps={{
195 class: 'font-bold',
196 }}
197 >
198 Layout A
199 </Link>
200 <Link
201 to="/layout-b"
202 activeProps={{
203 class: 'font-bold',
204 }}
205 >
206 Layout B
207 </Link>
208 </div>
209 <div>
210 <Outlet />
211 </div>
212 </div>
213 )
214}
215β
216const layoutARoute = createRoute({
217 getParentRoute: () => layout2Route,
218 path: '/layout-a',
219 component: LayoutAComponent,
220})
221β
222function LayoutAComponent() {
223 return <div>I'm layout A!</div>
224}
225β
226const layoutBRoute = createRoute({
227 getParentRoute: () => layout2Route,
228 path: '/layout-b',
229 component: LayoutBComponent,
230})
231β
232function LayoutBComponent() {
233 return <div>I'm layout B!</div>
234}
235β
236const routeTree = rootRoute.addChildren([
237 postsRoute.addChildren([postRoute, postsIndexRoute]),
238 layoutRoute.addChildren([
239 layout2Route.addChildren([layoutARoute, layoutBRoute]),
240 ]),
241 indexRoute,
242])
243β
244const queryClient = new QueryClient()
245β
246// Set up a Router instance
247const router = createRouter({
248 routeTree,
249 scrollRestoration: true,
250 defaultPreload: 'intent',
251 // Since we're using React Query, we don't want loader calls to ever be stale
252 // This will ensure that the loader is always called when the route is preloaded or visited
253 defaultPreloadStaleTime: 0,
254 context: {
255 queryClient,
256 },
257})
258β
259// Register things for typesafety
260declare module '@tanstack/solid-router' {
261 interface Register {
262 router: typeof router
263 }
264}
265β
266const rootElement = document.getElementById('app')!
267β
268if (!rootElement.innerHTML) {
269 render(
270 () => (
271 <QueryClientProvider client={queryClient}>
272 <RouterProvider router={router} />
273 </QueryClientProvider>
274 ),
275 rootElement,
276 )
277}