h1

h2

Documents

• Getting Started
• Tutorials
• APIs

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

Features

• Supports vertical/horizontal rolling.
• Supports circular/non-circular rolling.
• Supports auto rolling.
• Supports easing animations for rolling items.
• Supports custom events.

Examples

• Basic : Example of using default options.
• Using animation : Example of applying easing animation to rolling items.

More examples can be found on the left sidebar of each example page, and have fun with it.

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

bower

$ bower install tui-rolling # Latest version
$ bower install tui-rolling#<tag> # Specific version

Via Contents Delivery Network (CDN)

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

You can use CDN as below.

<script src="https://uicdn.toast.com/tui.rolling/latest/tui-rolling.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.rolling/
├─ latest
│  ├─ tui-rolling.js
│  ├─ tui-rolling.min.js
├─ v2.0.0/
│  ├─ ...

Download Source Files

• Download bundle files
• Download all sources for each version

Usage

HTML

Add the container element with children elements to create the component. See here for information about the added element.

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

const Rolling = tui.Rolling;

Using module format in node environment

const Rolling = require('tui-rolling'); /* CommonJS */

import Rolling from 'tui-rolling'; /* ES6 */

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

const instance = new Rolling({
  element: document.getElementById('rolling'),
  ...
});


instance.roll( ... );

For more information about the API, please see here.

Browser Support

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

Contributing

• Code of Conduct
• Contributing guideline
• Issue guideline
• Commit convention

TOAST UI Family

• TOAST UI Editor
• TOAST UI Calendar
• TOAST UI Chart
• TOAST UI Image-Editor
• TOAST UI Grid
• TOAST UI Components

License

This software is licensed under the MIT © NHN Cloud.