@vaadin/vaadin-virtual-list

<vaadin-virtual-list>

Live Demo ↗ | API documentation ↗

<vaadin-virtual-list> is a Web Component providing an accessible and customizable virtual-list, part of the Vaadin components.

<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>

Installation

Install vaadin-virtual-list:

npm i @vaadin/vaadin-virtual-list --save

Once installed, import it in your application:

import '@vaadin/vaadin-virtual-list/vaadin-virtual-list.js';

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The component with the Lumo theme:

  theme/lumo/vaadin-virtual-list.js

• The component with the Material theme:

  theme/material/vaadin-virtual-list.js

• Alias for theme/lumo/vaadin-virtual-list.js:

  vaadin-virtual-list.js

Contributing

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.

License

Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.