stencil-virtual-scroll

virtual-scroll typed web component that only render visible items on the DOM

Demo: https://virtual-scroll-demo.surge.sh

Why yet another virtual-scroll component?

The ion-virtual-scroll is only documented for Angular; not supported for react; undocumented and untyped for Javascript/Typescript (without framework)
The ion-virtual-scroll for Javascript doesn't allow content before / after it. i.e. It will occupy the entire page. (Workaround exist when providing renderHeader and renderFooter but still limiting the comsumer component structure)
The ion-virtual-scroll scroll height is not correct. The content height grow as you scroll, resulting 'endless list' feeling.

But why naming it stencil-virtual-scroll?

~~Because virtual-scroll is already occupied on npm.~~

Using this name for now in case people search for stencil style (typed) web component library.

Might rename it when better idea comes in. Welcome suggestions.

Features

Auto places items based on their size.
Support multiple columns in a row if the item width is smaller than the half of container width
Allow parent to instruct the container to re-render when updated
Allow lazy loading items instead of constructing a huge array
Written in Typescript

Components Properties

Examples with typed hints on Props

Below shows some usage examples of and .

Details refer to:

stencil-virtual-scroll-demo

Using for fixed-size cells in grid view:

import 'stencil-virtual-scroll'; // still need to import the library (js)

@Component({
  tag: 'virtual-scroll-demo',
  styleUrl: 'virtual-scroll-demo.css',
  scoped: true,
})
export class VirtualScrollDemo {

  render() {
    return (
      <div>
        before
        <virtual-scroll
          itemCount={100000}
          renderItem={i => <img src={`https://via.placeholder.com/600/${i}`}/>}
          itemWidth={48}
          itemHeight={48}
          style={{
            display: 'block',
            width: '100%',
            height: '450px',
            maxHeight: '80vh',
            outline: 'blue solid 1px',
          }}
        />
        after
      </div>
    );
  }

}

Details refer to:

virtual-scroll-demo

Using for vary-height items in list view:

import { Component, h, Host } from '@stencil/core';

const N = 100;
const width = 450;
const height = 50;
const heights = Array(N).fill(height)
  .map(height => Math.floor(height * (1 + Math.random() * 2)));

@Component({
  tag: 'virtual-scroll-list-demo',
  styleUrl: 'virtual-scroll-list-demo.css',
  scoped: true,
})
export class VirtualScrollListDemo {

  renderItem(i: number) {
    let height = heights[i];
    return <div style={{
      width: '450px',
      height: height + 'px',
      outline: '1px solid purple',
      position: 'relative',
    }}>
      {i}
    </div>;
  }

  render() {
    return (
      <Host>
        before
        <virtual-scroll-list
          itemCount={N}
          renderItem={i => this.renderItem(i)}
          itemWidth={width}
          itemHeights={heights}
          estimatedItemHeight={height}
          style={{
            display: 'block',
            width: '100%',
            height: '450px',
            maxHeight: '80vh',
            outline: 'blue solid 1px',
          }}
        />
        after
      </Host>
    );
  }

}

Details refer to:

virtual-scroll-list-demo

About Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Getting Started

To develop this web component using Stencil, clone this repo to a new directory:

git clone https://github.com/beenotung/stencil-virtual-scroll.git
cd stencil-virtual-scroll

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

The web component is published on npm as https://www.npmjs.com/package/stencil-virtual-scroll.

There are three options to use web components built with Stencil.

In a stencil-starter app (recommended)

Run npm install stencil-virtual-scroll --save
Add an import to the npm packages import 'stencil-virtual-scroll';
Then you can use the element anywhere in your template, JSX, html etc

Node Modules (need backend support)

Run npm install stencil-virtual-scroll --save
Put a script tag similar to this <script src='node_modules/stencil-virtual-scroll/dist/stencil-virtual-scroll.esm.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc

Script tag (easiest but depends on 3rd-party service)

Put a script tag similar to this <script src='https://unpkg.com/stencil-virtual-scroll@0.0.5/dist/stencil-virtual-scroll.esm.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc