Virtual ScrollAPI/ExamplesGithub

Renders only visible items according to the scroll position.


    Browser Support

    Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
    Yes 8+ Yes Yes Yes

    Features

    • Adds or deletes items while scrolling.
    • Adjusts the scroll position value.
    • Supports custom events.

    Examples

    • Basic : Example of using default options.

    Install

    TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

    Via Package Manager

    TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

    npm
    $ npm install --save tui-virtual-scroll # Latest version
    $ npm install --save tui-virtual-scroll@<version> # Specific version
    bower
    $ bower install tui-virtual-scroll # Latest version
    $ bower install tui-virtual-scroll#<tag> # Specific version

    Via Contents Delivery Network (CDN)

    TOAST UI products are available over a CDN powered by TOAST Cloud

    You can use CDN as below.

    <script src="https://uicdn.toast.com/tui.virtual-scroll/latest/tui-virtual-scroll.js"></script>
    

    If you want to use a specific version, use the tag name instead of latest in the url's path.

    The CDN directory has the following structure.

    tui.virtual-scroll/
    ├─ latest/
    │  ├─ tui-virtual-scroll.js
    │  ├─ tui-virtual-scroll.min.js
    ├─ v2.0.0/
    │  ├─ ...

    Download Source Files


    Usage

    HTML

    Add the container element to create the component.

    <div id="tui-virtual-scroll-container"></div>
    

    JavaScript

    This can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.

    Using namespace in browser environment
    var VirtualScroll = tui.VirtualScroll;
    
    Using module format in node environment
    var VirtualScroll = require('tui-virtual-scroll'); /* CommonJS */
    
    import {VirtualScroll} from 'tui-virtual-scoll'; /* ES6 */
    

    You can create an instance with options and call various APIs after creating an instance.

    var container = document.getElementById('tui-virtual-scroll-container');
    var instance = new VirtualScroll(container, { ... });
    
    instance.getItems();
    

    For more information about the API, please see here.


    Documents

    You can also see the older versions of API page on the releases page.


    Contributing


    License

    This software is licensed under the MIT © NHN Entertainment.