A web component for rendering a long list of items without sacrificing performance.
<vaadin-virtual-list></vaadin-virtual-list>
<script>
const list = document.querySelector('vaadin-virtual-list');
list.items = items; // An array of data items
list.renderer = (root, list, { item, index }) => {
root.textContent = `#${index}: ${item.name}`;
};
</script>
Install the component:
npm i @vaadin/virtual-list
Once installed, import the component in your application:
import '@vaadin/virtual-list';
Vaadin components come with two built-in themes, Lumo and Material. The main entrypoint of the package uses the Lumo theme.
To use the Material theme, import the component from the theme/material
folder:
import '@vaadin/virtual-list/theme/material/vaadin-virtual-list.js';
You can also import the Lumo version of the component explicitly:
import '@vaadin/virtual-list/theme/lumo/vaadin-virtual-list.js';
Finally, you can import the un-themed component from the src
folder to get a minimal starting point:
import '@vaadin/virtual-list/src/vaadin-virtual-list.js';
Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
Apache License 2.0
Vaadin collects usage statistics at development time to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.