TOAST UI Component : Rolling

Components that rotates and displays items such as a slideshow.

🚩 Table of Contents

Collect statistics on the use of open source
📙 Documents
🎨 Features
🐾 Examples
💾 Install
🔨 Usage
🌏 Browser Support
🔧 Pull Request Steps
💬 Contributing
🍞 TOAST UI Family
📜 License

Collect statistics on the use of open source

TOAST UI Rolling applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Rolling is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") 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.

const options = {
  element: document.getElementById('rolling'),
  //...
  usageStatistics: false
}

const instance = new Rolling(options);

Or, include tui-code-snippet(v2.2.0 or later) and then immediately write the options as follows:

tui.usageStatistics = false;

📙 Documents

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 TOAST 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

🔨 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

🔧 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.

Setup

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

$ git clone https://github.com/{your-personal-repo}/tui.rolling.git
$ cd tui.rolling
$ npm install
$ npm run test

Develop

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

Running dev server

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

Running test

$ npm run test

Pull Request

Before uploading your PR, run test one last time to check if there are any errors. If it has no errors, commit and then push it!

For more information on PR's steps, please see links in the Contributing section.

INSTANCE METHODS

EVENTS