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

main.ts

357 lines10.3 KB

1import { customElement, property } from 'lit/decorators.js'
2import { Ref, createRef, ref } from 'lit/directives/ref.js'
3import { html, LitElement } from 'lit'
4import { faker } from '@faker-js/faker'
5import { repeat } from 'lit/directives/repeat.js'
6import {
7 VirtualizerController,
8 WindowVirtualizerController,
9} from '@tanstack/lit-virtual'
10​
11interface Column {
12 key: string
13 name: string
14 width: number
16​
17function randomNumber(min: number, max: number) {
18 return faker.number.int({ min, max })
20​
21const sentences = new Array(10000)
22 .fill(true)
23 .map(() => faker.lorem.sentence(randomNumber(20, 70)))
24​
25const generateColumns = (count: number) => {
26 return new Array(count).fill(0).map((_, i) => {
27 const key: string = i.toString()
28 return {
29 key,
30 name: `Column ${i}`,
31 width: randomNumber(75, 300),
32 }
33 })
35​
36const generateData = (columns: Column[], count = 300) => {
37 return new Array(count).fill(0).map((_, rowIndex) =>
38 columns.reduce<string[]>((acc, _curr, colIndex) => {
39 // simulate dynamic size cells
40 const val = faker.lorem.lines(((rowIndex + colIndex) % 10) + 1)
41​
42 acc.push(val)
43​
44 return acc
45 }, []),
46 )
48​
49@customElement('row-virtualizer-dynamic')
50class RowVirtualizerDynamic extends LitElement {
51 private scrollElementRef: Ref<HTMLDivElement> = createRef()
52​
53 private virtualizerController: VirtualizerController<HTMLDivElement, Element>
54​
55 constructor() {
56 super()
57 this.virtualizerController = new VirtualizerController(this, {
58 getScrollElement: () => this.scrollElementRef.value,
59 count: sentences.length,
60 estimateSize: () => 45,
61 })
62 }
63​
64 render() {
65 const virtualizer = this.virtualizerController.getVirtualizer()
66 const virtualRows = virtualizer.getVirtualItems()
67 const count = sentences.length
68​
69 return html`
70 <div>
71 <button @click=${() => virtualizer.scrollToIndex(0)}>
72 scroll to the top
73 </button>
74 <button @click=${() => virtualizer.scrollToIndex(count / 2)}>
75 scroll to the middle
76 </button>
77 <button @click=${() => virtualizer.scrollToIndex(count - 1)}>
78 scroll to the end
79 </button>
80 <div class="list scroll-container" ${ref(this.scrollElementRef)}>
81 <div
82 style="position: relative; height: ${virtualizer.getTotalSize()}px; width: 100%;"
83 >
84 <div
85 style="position:absolute;top:0;left:0;width:100%;transform:translateY(${virtualRows[0]
86 ? virtualRows[0].start
87 : 0}px);"
88 >
89 ${repeat(
90 virtualRows,
91 (virtualRow) => virtualRow.key,
92 (virtualRow) =>
93 html` <div
94 data-index="${virtualRow.index}"
95 ${ref(virtualizer.measureElement)}
96 class="${virtualRow.index % 2 === 0
97 ? 'list-item-even'
98 : 'list-item-odd'}"
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 <style>
111 .list {
112 border: 1px solid #e6e4dc;
113 max-width: 100%;
114 }
115​
116 .list-item-even,
117 .list-item-odd {
118 display: flex;
119 align-items: center;
120 justify-content: center;
121 }
122​
123 .list-item-even {
124 background-color: #e6e4dc;
125 }
126​
127 .scroll-container {
128 height: 400px;
129 width: 400px;
130 overflow-y: auto;
131 }
132 </style>
133 `
134 }
136​
137@customElement('column-virtualizer-dynamic')
138class ColumnVirtualizerDynamic extends LitElement {
139 private scrollElementRef: Ref<HTMLDivElement> = createRef()
140​
141 private virtualizerController: VirtualizerController<HTMLDivElement, Element>
142​
143 constructor() {
144 super()
145 this.virtualizerController = new VirtualizerController(this, {
146 getScrollElement: () => this.scrollElementRef.value,
147 count: sentences.length,
148 estimateSize: () => 45,
149 horizontal: true,
150 })
151 }
152​
153 render() {
154 const virtualizer = this.virtualizerController.getVirtualizer()
155 const virtualColumns = virtualizer.getVirtualItems()
156​
157 return html`
158 <div>
159 <div class="list scroll-container" ${ref(this.scrollElementRef)}>
160 <div
161 style="position: relative; width: ${virtualizer.getTotalSize()}px; height: 100%;"
162 >
163 ${repeat(
164 virtualColumns,
165 (virtualColumn) => virtualColumn.key,
166 (virtualColumn) => html`
167 <div
168 data-index="${virtualColumn.index}"
169 style="position:absolute;top:0;left:0;height:100%;transform:translateX(${virtualColumn.start}px)"
170 ${ref(virtualizer.measureElement)}
171 class="${virtualColumn.index % 2 === 0
172 ? 'list-item-even'
173 : 'list-item-odd'}"
174 >
175 <div style="width:${sentences[virtualColumn.index].length}px">
176 <div>Column ${virtualColumn.index}</div>
177 <div>${sentences[virtualColumn.index]}</div>
178 </div>
179 </div>
180 `,
181 )}
182 </div>
183 </div>
184 </div>
185 <style>
186 *,
187 *:before,
188 *:after {
189 box-sizing: border-box;
190 }
191 .list {
192 border: 1px solid #e6e4dc;
193 max-width: 100%;
194 }
195​
196 .list-item-even {
197 background-color: #e6e4dc;
198 }
199​
200 .scroll-container {
201 height: 400px;
202 width: 400px;
203 overflow-y: auto;
204 }
205 </style>
206 `
207 }
209​
210@customElement('grid-virtualizer-dynamic')
211class GridVirtualizerDynamic extends LitElement {
212 @property()
213 private data: string[][]
214​
215 @property()
216 private columns: Column[]
217​
218 private parentElementRef: Ref<HTMLDivElement> = createRef()
219 private virtualizerController: WindowVirtualizerController<Element>
220​
221 private columnVirtualizerController: VirtualizerController<
222 HTMLDivElement,
223 Element
224 >
225​
226 private getColumnWidth(index: number) {
227 return this.columns[index].width
228 }
229​
230 connectedCallback() {
231 this.columnVirtualizerController = new VirtualizerController(this, {
232 horizontal: true,
233 count: this.columns.length,
234 getScrollElement: () => this.parentElementRef.value,
235 estimateSize: (index) => this.getColumnWidth(index),
236 overscan: 5,
237 })
238 this.virtualizerController = new WindowVirtualizerController(this, {
239 count: this.data.length,
240 estimateSize: () => 350,
241 overscan: 5,
242 })
243 super.connectedCallback()
244 }
245​
246 render() {
247 const virtualizer = this.virtualizerController.getVirtualizer()
248 const columnVirtualizer = this.columnVirtualizerController.getVirtualizer()
249 const columnItems = columnVirtualizer.getVirtualItems()
250 const [before, after] =
251 columnItems.length > 0
252 ? [
253 columnItems[0].start,
254 columnVirtualizer.getTotalSize() -
255 columnItems[columnItems.length - 1].end,
256 ]
257 : [0, 0]
258​
259 return html`
260 <div
261 ${ref(this.parentElementRef)}
262 style="overflow-y: auto;border: 1px solid #c8c8c8"
263 >
264 <div
265 style="position: relative; height: ${virtualizer.getTotalSize()}px"
266 >
267 ${repeat(
268 virtualizer.getVirtualItems(),
269 (row) => row.key,
270 (row) => html`
271 <div
272 data-index="${row.index}"
273 ${ref(virtualizer.measureElement)}
274 style="position:absolute;top:0;left:0;transform:translateY(${row.start -
275 virtualizer.options.scrollMargin}px);display:flex"
276 >
277 <div style="width:${before}px"></div>
278 ${columnItems.map(
279 (column) =>
280 html`<div
281 style="width: ${this.getColumnWidth(
282 column.index,
283 )}px;border-bottom: 1px solid #c8c8c8;border-right: 1px solid #c8c8c8; padding: 7px 12px;min-height: ${row.index ===
284 0
285 ? '50px'
286 : `100px`}"
287 >
288 ${row.index === 0
289 ? html`<div>${this.columns[column.index].name}</div>`
290 : html`<div>
291 ${this.data[row.index][column.index]}
292 </div>`}
293 </div>`,
294 )}
295 <div style="width:${after}px"></div>
296 </div>
297 `,
298 )}
299 </div>
300 </div>
301 <style></style>
302 `
303 }
305​
306@customElement('my-app')
307export class MyApp extends LitElement {
308 protected render() {
309 const { pathname } = window.location
310​
311 return html`
312 <div>
313 <p>
314 These components are using <strong>dynamic</strong> sizes. This means
315 that each element's exact dimensions are unknown when rendered. An
316 estimated dimension is used as the initial measurement, then this
317 measurement is readjusted on the fly as each element is rendered.
318 </p>
319 <nav>
320 <ul>
321 <li>
322 <a href="/">List</a>
323 </li>
324 <li>
325 <a href="/window-list">List - window as scroller</a>
326 </li>
327 <li>
328 <a href="/columns">Column</a>
329 </li>
330 <li>
331 <a href="/grid">Grid</a>
332 </li>
333 </ul>
334 </nav>
335​
336 ${(() => {
337 switch (pathname) {
338 case '/':
339 return html`<row-virtualizer-dynamic></row-virtualizer-dynamic>`
340 case '/columns':
341 return html`<column-virtualizer-dynamic></column-virtualizer-dynamic>`
342 case '/grid': {
343 const columns = generateColumns(30)
344 const data = generateData(columns)
345 return html`<grid-virtualizer-dynamic
346 .columns="${columns}"
347 .data="${data}"
348 ></grid-virtualizer-dynamic>`
349 }
350 default:
351 return html`<div>Not found</div>`
352 }
353 })()}
354 </div>
355 `
356 }