vue-virtual-scroll-grid-view v0.9.3

Virtual Scroll Grid for Vue 3

This is a reusable component for Vue 3 that renders a list with a huge number of items (e.g. 1000+ items) as a grid in a performant way.

• Demo
• NPM Package

Features

• Use virtual-scrolling / windowing to render the items, so the number of DOM nodes is kept low.
• Just use CSS grid to style your grid. Minimum styling opinions form the library.
• Support using a paginated API to load the items in the background.
• Support rendering placeholders for unloaded items
• Loaded items are cached for better performance.

Code Examples

• As an ES module (with a bundler)
• As an Universal Module Definition (no bundler)

Install

npm install vue-virtual-scroll-grid

Available Props

Example:

<Grid :length="1000"
      :pageProvider="async (pageNumber, pageSize) => Array(pageSize).fill('x')"
      :pageSize="40"
>
  <!-- ...slots -->
</Grid>

Available Slots

There are 3 scoped slots: default, placeholder and probe.

The default slot

The default slot is used to render a loaded item.

Props:

• item: the loaded item that is used for rendering your item element/component.
• index: the index of current item within the list.
• style: the style object provided by the library that need to be set on the item element/component.

Example:

<template v-slot:default="{ item, style, index }">
  <div :style="style">{{ item }} {{ index }}</div>
</template>

Theplaceholder slot

When an item is not loaded, the component/element in the placeholder slot will be used for rendering. The placeholder slot is optional. If missing, the space of unloaded items will be blank until they are loaded.

Props:

• index: the index of current item within the list.
• style: the style object provided by the library that need to be set on the item element/component.

Example:

<template v-slot:placeholder="{ index, style }">
  <div :style="style">Placeholder {{ index }}</div>
</template>

The probe slot

The probe slot is used to measure the visual size of grid item. It has no prop. You can pass the same element/component for the placeholder slot. If not provided, you must set a fixed height to grid-template-rows on your CSS grid, e.g. 200px. Otherwise, the view won't be rendered properly.

Example:

<template v-slot:probe>
  <div class="item">Probe</div>
</template>

Caveats

The library does not require items have foreknown width and height, but do require them to be styled with the same width and height under a view. E.g. the items can be 200px x 200px when the view is under 768px and 300px x 500px above 768px.

Development

Required environment variables:

• VITE_APP_ID: An Algolia app ID
• VITE_SEARCH_ONLY_API_KEY: The search API key for the Algolia app above

• Setup: npm install
• Run dev server: npm run dev
• Lint (type check): npm run lint
• Build the library: npm run build
• Build the demo: npm run build -- --mode=demo
• Preview the locally built demo: npm run serve

How to Release a New Version

npm version [major | minor | patch] -m 'build: bump version number'
npm publish