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

main.tsx

461 lines11.7 KB

1import * as React from 'react'
2import { createRoot } from 'react-dom/client'
3import { faker } from '@faker-js/faker'
4​
5import { useVirtualizer, useWindowVirtualizer } from '@tanstack/react-virtual'
6​
7import './index.css'
8​
9const randomNumber = (min: number, max: number) =>
10 faker.number.int({ min, max })
11​
12const sentences = new Array(10000)
13 .fill(true)
14 .map(() => faker.lorem.sentence(randomNumber(20, 70)))
15​
16function RowVirtualizerDynamic() {
17 const parentRef = React.useRef<HTMLDivElement>(null)
18​
19 const [enabled, setEnabled] = React.useState(true)
20​
21 const count = sentences.length
22 const virtualizer = useVirtualizer({
23 count,
24 getScrollElement: () => parentRef.current,
25 estimateSize: () => 45,
26 enabled,
27 })
28​
29 const items = virtualizer.getVirtualItems()
30​
31 return (
32 <div>
33 <button
34 onClick={() => {
35 virtualizer.scrollToIndex(0)
36 }}
37 >
38 scroll to the top
39 </button>
40 <span style={{ padding: '0 4px' }} />
41 <button
42 onClick={() => {
43 virtualizer.scrollToIndex(count / 2)
44 }}
45 >
46 scroll to the middle
47 </button>
48 <span style={{ padding: '0 4px' }} />
49 <button
50 onClick={() => {
51 virtualizer.scrollToIndex(count - 1)
52 }}
53 >
54 scroll to the end
55 </button>
56 <span style={{ padding: '0 4px' }} />
57 <button
58 onClick={() => {
59 setEnabled((prev) => !prev)
60 }}
61 >
62 turn {enabled ? 'off' : 'on'} virtualizer
63 </button>
64 <hr />
65 <div
66 ref={parentRef}
67 className="List"
68 style={{
69 height: 400,
70 width: 400,
71 overflowY: 'auto',
72 contain: 'strict',
73 }}
74 >
75 <div
76 style={{
77 height: virtualizer.getTotalSize(),
78 width: '100%',
79 position: 'relative',
80 }}
81 >
82 <div
83 style={{
84 position: 'absolute',
85 top: 0,
86 left: 0,
87 width: '100%',
88 transform: `translateY(${items[0]?.start ?? 0}px)`,
89 }}
90 >
91 {items.map((virtualRow) => (
92 <div
93 key={virtualRow.key}
94 data-index={virtualRow.index}
95 ref={virtualizer.measureElement}
96 className={
97 virtualRow.index % 2 ? 'ListItemOdd' : 'ListItemEven'
98 }
99 >
100 <div style={{ padding: '10px 0' }}>
101 <div>Row {virtualRow.index}</div>
102 <div>{sentences[virtualRow.index]}</div>
103 </div>
104 </div>
105 ))}
106 </div>
107 </div>
108 </div>
109 </div>
110 )
112​
113function ColumnVirtualizerDynamic() {
114 const parentRef = React.useRef<HTMLDivElement | null>(null)
115​
116 const virtualizer = useVirtualizer({
117 horizontal: true,
118 count: sentences.length,
119 getScrollElement: () => parentRef.current,
120 estimateSize: () => 45,
121 })
122​
123 return (
124 <>
125 <div
126 ref={parentRef}
127 className="List"
128 style={{ width: 400, height: 400, overflowY: 'auto' }}
129 >
130 <div
131 style={{
132 width: virtualizer.getTotalSize(),
133 height: '100%',
134 position: 'relative',
135 }}
136 >
137 {virtualizer.getVirtualItems().map((virtualColumn) => (
138 <div
139 key={virtualColumn.key}
140 data-index={virtualColumn.index}
141 ref={virtualizer.measureElement}
142 className={
143 virtualColumn.index % 2 ? 'ListItemOdd' : 'ListItemEven'
144 }
145 style={{
146 position: 'absolute',
147 top: 0,
148 left: 0,
149 height: '100%',
150 transform: `translateX(${virtualColumn.start}px)`,
151 }}
152 >
153 <div style={{ width: sentences[virtualColumn.index].length }}>
154 <div>Column {virtualColumn.index}</div>
155 <div>{sentences[virtualColumn.index]}</div>
156 </div>
157 </div>
158 ))}
159 </div>
160 </div>
161 </>
162 )
164​
165interface Column {
166 key: string
167 name: string
168 width: number
170​
171function GridVirtualizerDynamic({
172 columns,
173 data,
174}: {
175 data: Array<Array<string>>
176 columns: Array<Column>
177}) {
178 const parentRef = React.useRef<HTMLDivElement | null>(null)
179​
180 const parentOffsetRef = React.useRef(0)
181​
182 React.useLayoutEffect(() => {
183 parentOffsetRef.current = parentRef.current?.offsetTop ?? 0
184 }, [])
185​
186 const getColumnWidth = (index: number) => columns[index].width
187​
188 const virtualizer = useWindowVirtualizer({
189 count: data.length,
190 estimateSize: () => 350,
191 overscan: 5,
192 scrollMargin: parentOffsetRef.current,
193 })
194​
195 const columnVirtualizer = useVirtualizer({
196 horizontal: true,
197 count: columns.length,
198 getScrollElement: () => parentRef.current,
199 estimateSize: getColumnWidth,
200 overscan: 5,
201 })
202 const columnItems = columnVirtualizer.getVirtualItems()
203 const [before, after] =
204 columnItems.length > 0
205 ? [
206 columnItems[0].start,
207 columnVirtualizer.getTotalSize() -
208 columnItems[columnItems.length - 1].end,
209 ]
210 : [0, 0]
211​
212 return (
213 <div
214 ref={parentRef}
215 style={{ overflowY: 'auto', border: '1px solid #c8c8c8' }}
216 >
217 <div
218 style={{
219 height: virtualizer.getTotalSize(),
220 position: 'relative',
221 }}
222 >
223 {virtualizer.getVirtualItems().map((row) => {
224 return (
225 <div
226 key={row.key}
227 data-index={row.index}
228 ref={virtualizer.measureElement}
229 style={{
230 position: 'absolute',
231 top: 0,
232 left: 0,
233 transform: `translateY(${
234 row.start - virtualizer.options.scrollMargin
235 }px)`,
236 display: 'flex',
237 }}
238 >
239 <div style={{ width: `${before}px` }} />
240 {columnItems.map((column) => {
241 return (
242 <div
243 key={column.key}
244 style={{
245 minHeight: row.index === 0 ? 50 : row.size,
246 width: getColumnWidth(column.index),
247 borderBottom: '1px solid #c8c8c8',
248 borderRight: '1px solid #c8c8c8',
249 padding: '7px 12px',
250 }}
251 >
252 {row.index === 0 ? (
253 <div>{columns[column.index].name}</div>
254 ) : (
255 <div>{data[row.index][column.index]}</div>
256 )}
257 </div>
258 )
259 })}
260 <div style={{ width: `${after}px` }} />
261 </div>
262 )
263 })}
264 </div>
265 </div>
266 )
268​
269const generateColumns = (count: number) => {
270 return new Array(count).fill(0).map((_, i) => {
271 const key: string = i.toString()
272 return {
273 key,
274 name: `Column ${i}`,
275 width: randomNumber(75, 300),
276 }
277 })
279​
280const generateData = (columns: Array<Column>, count = 300) => {
281 return new Array(count).fill(0).map((_, rowIndex) =>
282 columns.reduce<Array<string>>((acc, _curr, colIndex) => {
283 // simulate dynamic size cells
284 const val = faker.lorem.lines(((rowIndex + colIndex) % 10) + 1)
285​
286 acc.push(val)
287​
288 return acc
289 }, []),
290 )
292​
293function RowVirtualizerExperimental() {
294 const parentRef = React.useRef<HTMLDivElement>(null)
295 const innerRef = React.useRef<HTMLDivElement>(null)
296 const rowRefsMap = React.useRef(new Map<number, HTMLDivElement>())
297​
298 const [enabled, setEnabled] = React.useState(true)
299​
300 const count = sentences.length
301 const virtualizer = useVirtualizer({
302 count,
303 getScrollElement: () => parentRef.current,
304 estimateSize: () => 45,
305 enabled,
306 onChange: (instance) => {
307 innerRef.current!.style.height = `${instance.getTotalSize()}px`
308 instance.getVirtualItems().forEach((virtualRow) => {
309 const rowRef = rowRefsMap.current.get(virtualRow.index)
310 if (!rowRef) return
311 rowRef.style.transform = `translateY(${virtualRow.start}px)`
312 })
313 },
314 })
315​
316 const indexes = virtualizer.getVirtualIndexes()
317​
318 React.useEffect(() => {
319 virtualizer.measure()
320 }, [])
321​
322 return (
323 <div>
324 <button
325 onClick={() => {
326 virtualizer.scrollToIndex(0)
327 }}
328 >
329 scroll to the top
330 </button>
331 <span style={{ padding: '0 4px' }} />
332 <button
333 onClick={() => {
334 virtualizer.scrollToIndex(count / 2)
335 }}
336 >
337 scroll to the middle
338 </button>
339 <span style={{ padding: '0 4px' }} />
340 <button
341 onClick={() => {
342 virtualizer.scrollToIndex(count - 1)
343 }}
344 >
345 scroll to the end
346 </button>
347 <span style={{ padding: '0 4px' }} />
348 <button
349 onClick={() => {
350 setEnabled((prev) => !prev)
351 }}
352 >
353 turn {enabled ? 'off' : 'on'} virtualizer
354 </button>
355 <hr />
356 <div
357 ref={parentRef}
358 className="List"
359 style={{
360 height: 400,
361 width: 400,
362 overflowY: 'auto',
363 contain: 'strict',
364 }}
365 >
366 <div
367 ref={innerRef}
368 style={{
369 width: '100%',
370 position: 'relative',
371 }}
372 >
373 {indexes.map((index) => (
374 <div
375 key={index}
376 data-index={index}
377 ref={(el) => {
378 if (el) {
379 virtualizer.measureElement(el)
380 rowRefsMap.current.set(index, el)
381 }
382 }}
383 className={index % 2 ? 'ListItemOdd' : 'ListItemEven'}
384 >
385 <div style={{ padding: '10px 0' }}>
386 <div>Row {index}</div>
387 <div>{sentences[index]}</div>
388 </div>
389 </div>
390 ))}
391 </div>
392 </div>
393 </div>
394 )
396​
397function App() {
398 const pathname = location.pathname
399 return (
400 <div>
401 <p>
402 These components are using <strong>dynamic</strong> sizes. This means
403 that each element's exact dimensions are unknown when rendered. An
404 estimated dimension is used as the initial measurement, then this
405 measurement is readjusted on the fly as each element is rendered.
406 </p>
407 <nav>
408 <ul>
409 <li>
410 <a href="/">List</a>
411 </li>
412 <li>
413 <a href="/columns">Column</a>
414 </li>
415 <li>
416 <a href="/grid">Grid</a>
417 </li>
418 <li>
419 <a href="/experimental">Experimental</a>
420 </li>
421 </ul>
422 </nav>
423 {(() => {
424 switch (pathname) {
425 case '/':
426 return <RowVirtualizerDynamic />
427 case '/columns':
428 return <ColumnVirtualizerDynamic />
429 case '/grid': {
430 const columns = generateColumns(30)
431 const data = generateData(columns)
432 return <GridVirtualizerDynamic columns={columns} data={data} />
433 }
434 case '/experimental':
435 return <RowVirtualizerExperimental />
436 default:
437 return <div>Not found</div>
438 }
439 })()}
440 <br />
441 <br />
442 {process.env.NODE_ENV === 'development' ? (
443 <p>
444 <strong>Notice:</strong> You are currently running React in
445 development mode. Rendering performance will be slightly degraded
446 until this application is built for production.
447 </p>
448 ) : null}
449 </div>
450 )
452​
453const container = document.getElementById('root')!
454const root = createRoot(container)
455const { StrictMode } = React
456​
457root.render(
458 <StrictMode>
459 <App />
460 </StrictMode>,