Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
jung-han chore: change company name(nhnent -> nhn) (#11)
* chore: change company name(nhnent -> nhn)

* chore: change karma config set
Latest commit 323815c Apr 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs feat: update documents (close #3) Feb 11, 2018
examples feat: apply tuidoc (close #9) (#10) Feb 11, 2019
src/js chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
test
.eslintrc.js feat: change files to register npm (#15) Oct 12, 2017
.gitignore feat: change files to register npm (#15) Oct 12, 2017
CODE_OF_CONDUCT.md
CONTRIBUTING.md chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
ISSUE_TEMPLATE.md chore: add issue template Jan 10, 2018
LICENSE chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
README.md chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
bower.json
jsdoc.conf.json feat: change files to register npm (#15) Oct 12, 2017
karma.conf.js chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
package-lock.json feat: apply tuidoc (close #9) (#10) Feb 11, 2019
package.json chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019
tuidoc.config.json
webpack.config.js chore: change company name(nhnent -> nhn) (#11) Apr 8, 2019

README.md

TOAST UI Component : Flicking

Component that supports flicking effect on mobile touch events.

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 Flicking applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Flicking 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.

var options = {
    ...
    usageStatistics: false
}

var instance = new Flicking(options);

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

tui.usageStatistics = false;

🎨 Features

  • Supports vertical/horizontal swipe.
  • Supports circular/non-circular flicking.
  • Supports custom events.

🐾 Examples

  • Basic : Example of using default options.

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

bower

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

Via Contents Delivery Network (CDN)

TOAST UI products are available over the CDN powered by TOAST Cloud.

You can use the CDN as below.

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

Download Source Files

🔨 Usage

HTML

Add the container element to create the component as an option. 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

var Flicking = tui.Flicking;

Using module format in node environment

var Flicking = require('tui-flicking'); /* CommonJS */
import Flicking from 'tui-flicking'; /* ES6 */

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

var instance = new Flicking({ ... });

instance.setNext();

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.

Setup

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 https://github.com/{your-personal-repo}/tui.flicking.git
$ cd tui.flicking
$ npm install
$ npm run test

Develop

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.

You can’t perform that action at this time.