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

main.tsx

263 lines7.2 KB

1import React from 'react'
2import * as ReactDOM from 'react-dom/client'
3​
4import './index.css'
5​
6import { useVirtualizer } from '@tanstack/react-virtual'
7​
8const rows = new Array(10000)
9 .fill(true)
10 .map(() => 25 + Math.round(Math.random() * 100))
11​
12const columns = new Array(10000)
13 .fill(true)
14 .map(() => 75 + Math.round(Math.random() * 100))
15​
16function App() {
17 return (
18 <div>
19 <p>
20 These components are using <strong>dynamic</strong> sizes. This means
21 that each element's exact dimensions are unknown when rendered. An
22 estimated dimension is used as the initial measurement, then this
23 measurement is readjusted on the fly as each element is rendered.
24 </p>
25 <br />
26 <br />
27​
28 <h3>Rows</h3>
29 <RowVirtualizerDynamic rows={rows} />
30 <br />
31 <br />
32 <h3>Columns</h3>
33 <ColumnVirtualizerDynamic columns={columns} />
34 <br />
35 <br />
36 <h3>Grid</h3>
37 <GridVirtualizerDynamic rows={rows} columns={columns} />
38 </div>
39 )
41​
42function RowVirtualizerDynamic({ rows }: { rows: Array<number> }) {
43 const parentRef = React.useRef<HTMLDivElement>(null)
44​
45 const rowVirtualizer = useVirtualizer({
46 count: rows.length,
47 getScrollElement: () => parentRef.current,
48 estimateSize: () => 50,
49 paddingStart: 100,
50 paddingEnd: 100,
51 })
52​
53 return (
54 <>
55 <div
56 ref={parentRef}
57 className="List"
58 style={{
59 height: `200px`,
60 width: `400px`,
61 overflow: 'auto',
62 }}
63 >
64 <div
65 style={{
66 height: `${rowVirtualizer.getTotalSize()}px`,
67 width: '100%',
68 position: 'relative',
69 }}
70 >
71 {rowVirtualizer.getVirtualItems().map((virtualRow) => (
72 <div
73 key={virtualRow.key}
74 data-index={virtualRow.index}
75 ref={rowVirtualizer.measureElement}
76 className={virtualRow.index % 2 ? 'ListItemOdd' : 'ListItemEven'}
77 style={{
78 position: 'absolute',
79 top: 0,
80 left: 0,
81 width: '100%',
82 height: `${rows[virtualRow.index]}px`,
83 transform: `translateY(${virtualRow.start}px)`,
84 }}
85 >
86 Row {virtualRow.index}
87 </div>
88 ))}
89 </div>
90 </div>
91 </>
92 )
94​
95function ColumnVirtualizerDynamic({ columns }: { columns: Array<number> }) {
96 const parentRef = React.useRef<HTMLDivElement>(null)
97​
98 const columnVirtualizer = useVirtualizer({
99 horizontal: true,
100 count: columns.length,
101 getScrollElement: () => parentRef.current,
102 estimateSize: () => 50,
103 paddingStart: 100,
104 paddingEnd: 100,
105 })
106​
107 return (
108 <>
109 <div
110 ref={parentRef}
111 className="List"
112 style={{
113 width: `400px`,
114 height: `100px`,
115 overflow: 'auto',
116 }}
117 >
118 <div
119 style={{
120 width: `${columnVirtualizer.getTotalSize()}px`,
121 height: '100%',
122 position: 'relative',
123 }}
124 >
125 {columnVirtualizer.getVirtualItems().map((virtualColumn) => (
126 <div
127 key={virtualColumn.key}
128 data-index={virtualColumn.index}
129 ref={columnVirtualizer.measureElement}
130 className={
131 virtualColumn.index % 2 ? 'ListItemOdd' : 'ListItemEven'
132 }
133 style={{
134 position: 'absolute',
135 top: 0,
136 left: 0,
137 height: '100%',
138 width: `${columns[virtualColumn.index]}px`,
139 transform: `translateX(${virtualColumn.start}px)`,
140 }}
141 >
142 Column {virtualColumn.index}
143 </div>
144 ))}
145 </div>
146 </div>
147 </>
148 )
150​
151function GridVirtualizerDynamic({
152 rows,
153 columns,
154}: {
155 rows: Array<number>
156 columns: Array<number>
157}) {
158 const parentRef = React.useRef<HTMLDivElement>(null)
159​
160 const rowVirtualizer = useVirtualizer({
161 count: rows.length,
162 getScrollElement: () => parentRef.current,
163 estimateSize: () => 50,
164 paddingStart: 200,
165 paddingEnd: 200,
166 indexAttribute: 'data-row-index',
167 })
168​
169 const columnVirtualizer = useVirtualizer({
170 horizontal: true,
171 count: columns.length,
172 getScrollElement: () => parentRef.current,
173 estimateSize: () => 50,
174 paddingStart: 200,
175 paddingEnd: 200,
176 indexAttribute: 'data-column-index',
177 })
178​
179 const [show, setShow] = React.useState(true)
180​
181 const halfWay = Math.floor(rows.length / 2)
182​
183 return (
184 <>
185 <button onClick={() => setShow((old) => !old)}>Toggle</button>
186 <button onClick={() => rowVirtualizer.scrollToIndex(halfWay)}>
187 Scroll to index {halfWay}
188 </button>
189 <button onClick={() => rowVirtualizer.scrollToIndex(rows.length - 1)}>
190 Scroll to index {rows.length - 1}
191 </button>
192 {show ? (
193 <div
194 ref={parentRef}
195 className="List"
196 style={{
197 height: `400px`,
198 width: `500px`,
199 overflow: 'auto',
200 }}
201 >
202 <div
203 style={{
204 height: `${rowVirtualizer.getTotalSize()}px`,
205 width: `${columnVirtualizer.getTotalSize()}px`,
206 position: 'relative',
207 }}
208 >
209 {rowVirtualizer.getVirtualItems().map((virtualRow) => (
210 <React.Fragment key={virtualRow.key}>
211 {columnVirtualizer.getVirtualItems().map((virtualColumn) => (
212 <div
213 key={virtualColumn.key}
214 data-row-index={virtualRow.index}
215 data-column-index={virtualColumn.index}
216 ref={(el) => {
217 rowVirtualizer.measureElement(el)
218 columnVirtualizer.measureElement(el)
219 }}
220 className={
221 virtualColumn.index % 2
222 ? virtualRow.index % 2 === 0
223 ? 'ListItemOdd'
224 : 'ListItemEven'
225 : virtualRow.index % 2
226 ? 'ListItemOdd'
227 : 'ListItemEven'
228 }
229 style={{
230 position: 'absolute',
231 top: 0,
232 left: 0,
233 width: `${columns[virtualColumn.index]}px`,
234 height: `${rows[virtualRow.index]}px`,
235 transform: `translateX(${virtualColumn.start}px) translateY(${virtualRow.start}px)`,
236 }}
237 >
238 Cell {virtualRow.index}, {virtualColumn.index}
239 </div>
240 ))}
241 </React.Fragment>
242 ))}
243 </div>
244 </div>
245 ) : null}
246 <br />
247 <br />
248 {process.env.NODE_ENV === 'development' ? (
249 <p>
250 <strong>Notice:</strong> You are currently running React in
251 development mode. Rendering performance will be slightly degraded
252 until this application is built for production.
253 </p>
254 ) : null}
255 </>
256 )
258​
259ReactDOM.createRoot(document.getElementById('root')!).render(
260 <React.StrictMode>
261 <App />
262 </React.StrictMode>,