Open History to see the last commit
1import { render } from 'solid-js/web'
2import {
3 Link,
4 Outlet,
5 RouterProvider,
6 createRootRoute,
7 createRoute,
8 createRouter,
9 useElementScrollRestoration,
10} from '@tanstack/solid-router'
11import { TanStackRouterDevtools } from '@tanstack/solid-router-devtools'
12import { createVirtualizer } from '@tanstack/solid-virtual'
13import './styles.css'
14β
15const rootRoute = createRootRoute({
16 component: RootComponent,
17})
18β
19function RootComponent() {
20 return (
21 <>
22 <div class="p-2 flex gap-2 sticky top-0 border-b bg-gray-100 dark:bg-gray-900">
23 <Link to="/" class="[&.active]:font-bold">
24 Home
25 </Link>{' '}
26 <Link to="/about" class="[&.active]:font-bold">
27 About
28 </Link>
29 <Link to="/about" resetScroll={false}>
30 About (No Reset)
31 </Link>
32 <Link to="/by-element" class="[&.active]:font-bold">
33 By-Element
34 </Link>
35 </div>
36 <Outlet />
37 <TanStackRouterDevtools />
38 </>
39 )
40}
41β
42const indexRoute = createRoute({
43 getParentRoute: () => rootRoute,
44 path: '/',
45 loader: () => new Promise<void>((r) => setTimeout(r, 500)),
46 component: IndexComponent,
47})
48β
49function IndexComponent() {
50 return (
51 <div class="p-2">
52 <h3>Welcome Home!</h3>
53 <div class="space-y-2">
54 {Array.from({ length: 50 }).map((_, i) => (
55 <div class="h-[100px] p-2 rounded-lg bg-gray-200 dark:bg-gray-800 border">
56 Home Item {i + 1}
57 </div>
58 ))}
59 </div>
60 </div>
61 )
62}
63β
64const aboutRoute = createRoute({
65 getParentRoute: () => rootRoute,
66 path: '/about',
67 loader: () => new Promise<void>((r) => setTimeout(r, 500)),
68 component: AboutComponent,
69})
70β
71function AboutComponent() {
72 return (
73 <div class="p-2">
74 <div>Hello from About!</div>
75 <div class="space-y-2">
76 {Array.from({ length: 50 }).map((_, i) => (
77 <div class="h-[100px] p-2 rounded-lg bg-gray-200 dark:bg-gray-800 border">
78 About Item {i + 1}
79 </div>
80 ))}
81 </div>
82 </div>
83 )
84}
85β
86const byElementRoute = createRoute({
87 getParentRoute: () => rootRoute,
88 path: '/by-element',
89 loader: () => new Promise<void>((r) => setTimeout(r, 500)),
90 component: ByElementComponent,
91})
92β
93function ByElementComponent() {
94 // We need a unique ID for manual scroll restoration on a specific element
95 // It should be as unique as possible for this element across your app
96 const scrollRestorationId = 'myVirtualizedContent'
97β
98 // We use that ID to get the scroll entry for this element
99 const scrollEntry = useElementScrollRestoration({
100 id: scrollRestorationId,
101 })
102β
103 // Let's use TanStack Virtual to virtualize some content!
104 let virtualizerParentRef: any
105 const virtualizer = createVirtualizer({
106 count: 10000,
107 getScrollElement: () => virtualizerParentRef,
108 estimateSize: () => 100,
109 // We pass the scrollY from the scroll restoration entry to the virtualizer
110 // as the initial offset
111 initialOffset: scrollEntry?.scrollY,
112 })
113β
114 return (
115 <div class="p-2 h-[calc(100vh-41px)] flex flex-col">
116 <div>Hello from By-Element!</div>
117 <div class="h-full min-h-0 flex gap-4">
118 <div class="border rounded-lg p-2 overflow-auto flex-1 space-y-2">
119 {Array.from({ length: 50 }).map((_, i) => (
120 <div class="h-[100px] p-2 rounded-lg bg-gray-200 dark:bg-gray-800 border">
121 About Item {i + 1}
122 </div>
123 ))}
124 </div>
125 <div class="flex-1 overflow-auto flex flex-col gap-4">
126 {Array.from({ length: 2 }).map((_, i) => (
127 <div class="flex-1 border rounded-lg p-2 overflow-auto">
128 <div class="space-y-2">
129 {Array.from({ length: 50 }).map((_, i) => (
130 <div class="h-[100px] p-2 rounded-lg bg-gray-200 dark:bg-gray-800 border">
131 About Item {i + 1}
132 </div>
133 ))}
134 </div>
135 </div>
136 ))}
137 <div class="flex-1 flex flex-col min-h-0">
138 <div class="font-bold">Virtualized</div>
139 <div
140 ref={virtualizerParentRef}
141 // We pass the scroll restoration ID to the element
142 // as a custom attribute that will get picked up by the
143 // scroll restoration watcher
144 data-scroll-restoration-id={scrollRestorationId}
145 class="flex-1 border rounded-lg overflow-auto relative"
146 >
147 <div
148 style={{
149 height: `${virtualizer.getTotalSize()}px`,
150 }}
151 >
152 {virtualizer.getVirtualItems().map((item) => (
153 <div
154 class="absolute p-2 pb-0 w-full"
155 style={{
156 height: item.size + 'px',
157 top: item.start + 'px',
158 }}
159 >
160 <div class="p-2 rounded-lg bg-gray-200 dark:bg-gray-800 border h-full">
161 Virtualized Item {item.index + 1}
162 </div>
163 </div>
164 ))}
165 </div>
166 </div>
167 </div>
168 </div>
169 </div>
170 </div>
171 )
172}
173β
174const routeTree = rootRoute.addChildren([
175 indexRoute,
176 aboutRoute,
177 byElementRoute,
178])
179β
180const router = createRouter({
181 routeTree,
182 defaultPreload: 'intent',
183 scrollRestoration: true,
184})
185β
186declare module '@tanstack/solid-router' {
187 interface Register {
188 router: typeof router
189 }
190}
191β
192const rootElement = document.getElementById('app')!
193β
194if (!rootElement.innerHTML) {
195 render(() => <RouterProvider router={router} />, rootElement)
196}