npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »


2.1.3 • Public • Published

TOAST UI Component : Virtual Scroll

Component that renders only visible items according to the scroll position when there are too many items to render.

GitHub release npm GitHub license PRs welcome code with hearth by NHN

🚩 Table of Contents

Collect statistics on the use of open source

TOAST UI VirtualScroll applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI VirtualScroll is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following usageStatistics option when creating the instance.

var options = {
   usageStatistics: false
var instance = new VirtualScroll(container, options);

🌏 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 install --save tui-virtual-scroll # Latest version 
$ npm install --save tui-virtual-scroll@<version> # Specific version 


$ 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=""></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.

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

Download Source Files

🔨 Usage


Add the container element to create the component.

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


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, { ... });

For more information about the API, please see here.

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.


Fork develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone{your-personal-repo}/tui.virtual-scroll.git
cd tui.virtual-scroll
$ npm install
$ npm run test


Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8 

Run karma test

$ npm run test

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

For more information on PR's step, please see links of Contributing section.

📙 Documents

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

💬 Contributing

🔩 Dependency

📜 License

This software is licensed under the MIT © NHN.


npm i tui-virtual-scroll

Downloadsweekly downloads









last publish


  • avatar
Report a vulnerability