Open History to see the last commit
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
15}
16β
17function randomNumber(min: number, max: number) {
18 return faker.number.int({ min, max })
19}
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 })
34}
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 )
47}
48β
49@customElement('row-virtualizer-fixed')
50class RowVirtualizerFixed 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: 10000,
60 estimateSize: () => 35,
61 overscan: 5,
62 })
63 }
64β
65 render() {
66 const virtualizer = this.virtualizerController.getVirtualizer()
67 const virtualRows = virtualizer.getVirtualItems()
68β
69 return html`
70 <div>
71 <div class="list scroll-container" ${ref(this.scrollElementRef)}>
72 <div
73 style="position: relative; height: ${virtualizer.getTotalSize()}px; width: 100%;"
74 >
75 ${repeat(
76 virtualRows,
77 (virtualRow) => virtualRow.key,
78 (virtualRow) =>
79 html` <div
80 class="${virtualRow.index % 2 === 0
81 ? 'list-item-even'
82 : 'list-item-odd'}"
83 style="position: absolute; left: 0; top: 0; width: 100%; height: ${virtualRow.size}px; transform: translateY(${virtualRow.start}px)"
84 >
85 Row ${virtualRow.index}
86 </div>`,
87 )}
88 </div>
89 </div>
90 </div>
91 <style>
92 .list {
93 border: 1px solid #e6e4dc;
94 max-width: 100%;
95 }
96β
97 .list-item-even,
98 .list-item-odd {
99 display: flex;
100 align-items: center;
101 justify-content: center;
102 }
103β
104 .list-item-even {
105 background-color: #e6e4dc;
106 }
107β
108 .scroll-container {
109 height: 200px;
110 width: 400px;
111 overflow: auto;
112 }
113 </style>
114 `
115 }
116}
117β
118@customElement('column-virtualizer-fixed')
119class ColumnVirtualizerFixed extends LitElement {
120 private scrollElementRef: Ref<HTMLDivElement> = createRef()
121β
122 private virtualizerController: VirtualizerController<HTMLDivElement, Element>
123β
124 constructor() {
125 super()
126 this.virtualizerController = new VirtualizerController(this, {
127 getScrollElement: () => this.scrollElementRef.value,
128 count: sentences.length,
129 estimateSize: () => 100,
130 horizontal: true,
131 })
132 }
133β
134 render() {
135 const virtualizer = this.virtualizerController.getVirtualizer()
136 const virtualColumns = virtualizer.getVirtualItems()
137β
138 return html`
139 <div>
140 <div class="list scroll-container" ${ref(this.scrollElementRef)}>
141 <div
142 style="position: relative; height: 100%; width: ${virtualizer.getTotalSize()}px;"
143 >
144 ${repeat(
145 virtualColumns,
146 (virtualColumn) => virtualColumn.key,
147 (virtualColumn) =>
148 html` <div
149 class="${virtualColumn.index % 2 === 0
150 ? 'list-item-even'
151 : 'list-item-odd'}"
152 style="position: absolute; left: 0; top: 0; height: 100%; width: ${virtualColumn.size}px; transform: translateX(${virtualColumn.start}px)"
153 >
154 Column ${virtualColumn.index}
155 </div>`,
156 )}
157 </div>
158 </div>
159 </div>
160 <style>
161 .list {
162 border: 1px solid #e6e4dc;
163 max-width: 100%;
164 }
165β
166 .list-item-even,
167 .list-item-odd {
168 display: flex;
169 align-items: center;
170 justify-content: center;
171 }
172β
173 .list-item-even {
174 background-color: #e6e4dc;
175 }
176β
177 .scroll-container {
178 height: 100px;
179 width: 400px;
180 overflow: auto;
181 }
182 </style>
183 `
184 }
185}
186β
187@customElement('grid-virtualizer-fixed')
188class GridVirtualizerFixed extends LitElement {
189 private scrollElementRef: Ref<HTMLDivElement> = createRef()
190β
191 private rowVirtualizerController: VirtualizerController<
192 HTMLDivElement,
193 Element
194 >
195 private columnVirtualizerController: VirtualizerController<
196 HTMLDivElement,
197 Element
198 >
199β
200 constructor() {
201 super()
202 this.rowVirtualizerController = new VirtualizerController(this, {
203 getScrollElement: () => this.scrollElementRef.value,
204 count: sentences.length,
205 estimateSize: () => 35,
206 overscan: 5,
207 })
208β
209 this.columnVirtualizerController = new VirtualizerController(this, {
210 getScrollElement: () => this.scrollElementRef.value,
211 count: sentences.length,
212 estimateSize: () => 100,
213 horizontal: true,
214 overscan: 5,
215 })
216 }
217β
218 render() {
219 const rowVirtualizer = this.rowVirtualizerController.getVirtualizer()
220 const columnVirtualizer = this.columnVirtualizerController.getVirtualizer()
221β
222 return html`
223 <div>
224 <div class="list scroll-container" ${ref(this.scrollElementRef)}>
225 <div
226 style="position: relative; height: ${rowVirtualizer.getTotalSize()}px; width: ${columnVirtualizer.getTotalSize()}px;"
227 >
228 ${repeat(
229 rowVirtualizer.getVirtualItems(),
230 (virtualRow) => virtualRow.key,
231 (virtualRow) =>
232 repeat(
233 columnVirtualizer.getVirtualItems(),
234 (virtualColumn) => virtualColumn.key,
235 (virtualColumn) => html`
236 <div
237 class="${virtualColumn.index % 2
238 ? virtualRow.index % 2 === 0
239 ? 'list-item-odd'
240 : 'list-item-even'
241 : virtualRow.index % 2
242 ? 'list-item-odd'
243 : 'list-item-even'}"
244 style="position: absolute;left: 0; top: 0; width: ${virtualColumn.size}px; height: ${virtualRow.size}px; transform: translateX(${virtualColumn.start}px) translateY(${virtualRow.start}px)"
245 >
246 Cell ${virtualRow.index}, ${virtualColumn.index}
247 </div>
248 `,
249 ),
250 )}
251 </div>
252 </div>
253 </div>
254 <style>
255 .list {
256 border: 1px solid #e6e4dc;
257 max-width: 100%;
258 }
259β
260 .list-item-even,
261 .list-item-odd {
262 display: flex;
263 align-items: center;
264 justify-content: center;
265 }
266β
267 .list-item-even {
268 background-color: #e6e4dc;
269 }
270β
271 .scroll-container {
272 height: 500px;
273 width: 500px;
274 overflow: auto;
275 }
276 </style>
277 `
278 }
279}
280β
281@customElement('my-app')
282export class MyApp extends LitElement {
283 protected render() {
284 const { pathname } = window.location
285β
286 return html`
287 <div>
288 <p>
289 These components are using <strong>fixed</strong> sizes. This means
290 that every element's dimensions are hard-coded to the same value and
291 never change.
292 </p>
293 <br />
294 <br />
295β
296 <h3>Rows</h3>
297 <row-virtualizer-fixed></row-virtualizer-fixed>
298 <br />
299 <br />
300 <h3>Columns</h3>
301 <column-virtualizer-fixed></column-virtualizer-fixed>
302 <br />
303 <br />
304 <h3>Grid</h3>
305 <grid-virtualizer-fixed></grid-virtualizer-fixed>
306 <br />
307 <br />
308 </div>
309 `
310 }
311}