@egjs/axes/README.md

# egjs-axes [![npm version](https://badge.fury.io/js/%40egjs%2Faxes.svg)](https://badge.fury.io/js/%40egjs%2Faxes) [![Build Status](https://travis-ci.org/naver/egjs-axes.svg?branch=master)](https://travis-ci.org/naver/egjs-axes) [![Coverage Status](https://coveralls.io/repos/github/naver/egjs-axes/badge.svg?branch=master)](https://coveralls.io/github/naver/egjs-axes?branch=master)

A module used to change the information of user action entered by various input devices such as touch screen or mouse into the logical virtual coordinates.  

<img src="https://github.com/naver/egjs-axes/raw/master/demo/assets/image/structure.png" style="width:100%">

You can easily create a UI that responds to user actions.

![showcase using egjs-axes](https://github.com/naver/egjs-axes/raw/master/demo/assets/image/showcase.gif)

## Documents
- [Get Started and Demos](https://naver.github.io/egjs-axes/)
- [API documentation](https://naver.github.io/egjs-axes/release/latest/doc/)
- [How to create an ui that responds to user actions using eg.axes](https://medium.com/@sculove/how-to-create-a-ui-that-responds-to-user-actions-using-eg-axes-5037d180d5ab)
- [How to create a custom InputType](https://github.com/naver/egjs-axes/wiki/How-to-create-a-custom-InputType)



## Third party applications
 - [@egjs/react-axes](https://github.com/naver/egjs-axes/tree/master/packages/react): A react component that can easily use egjs-axes

## Download and Installation

Download dist files from repo directly or install it via npm. 

### For development (Uncompressed)

You can download the uncompressed files for development

- Latest : https://naver.github.io/egjs-axes/release/latest/dist/axes.js
- Specific version : https://naver.github.io/egjs-axes/release/[VERSION]/dist/axes.js

### For production (Compressed)

You can download the compressed files for production

- Latest : https://naver.github.io/egjs-axes/release/latest/dist/axes.min.js
- Specific version : https://naver.github.io/egjs-axes/release/[VERSION]/dist/axes.min.js

### Packaged version (with Dependencies)
> Packaged version is not an official distribution.
> Is just to provide for ease use of 'egjs-axes' with dependency.

 - **Latest**
    - https://naver.github.io/egjs-axes/release/latest/dist/axes.pkgd.js
    - https://naver.github.io/egjs-axes/release/latest/dist/axes.pkgd.min.js

 - **Specific version**
    - https://naver.github.io/egjs-axes/release/[VERSION]/dist/axes.pkgd.js
    - https://naver.github.io/egjs-axes/release/[VERSION]/dist/axes.pkgd.min.js

### Installation with npm

The following command shows how to install egjs-axes using npm.

```bash
$ npm install @egjs/axes
```


## Supported Browsers
The following are the supported browsers.

|Internet Explorer|Chrome|Firefox|Safari|iOS|Android|
|---|---|---|---|---|---|
|10+|Latest|Latest|Latest|7+|2.3+(except 3.x)|

## Dependency

egjs-axes has the dependencies for the following libraries:

|[egjs-component](http://github.com/naver/egjs-component)|[Hammer.JS](http://hammerjs.github.io/)|
|----|----|
|2.0.0+|2.0.4+|



## Edge swipe issue in iOS Safari
When swipe on iOS safari edge, clientX bounces or stops the touch event.

* When swiping from left to right, clientX is minus.
* Swiping from right to left stops the touch event.

In Axes, this was solved by forcing the `release` event in this problem.

* hold -> change -> **release(forced release)**



## How to start developing egjs-axes?

For anyone interested to develop egjs-axes, follow the instructions below.

### Development Environment

#### 1. Clone the repository

Clone the egjs-axes repository and install the dependency modules.

```bash
# Clone the repository.
$ git clone https://github.com/naver/egjs-axes.git
```

#### 2. Install dependencies
`npm` is supported.

```
# Install the dependency modules.
$ npm install
```

#### 3. Build

Use npm script to build eg.Axes

```bash
# Run webpack-dev-server for development
$ npm start

# Build
$ npm run build

# Generate jsdoc
$ npm run jsdoc
```

Two folders will be created after complete build is completed.

- **dist** folder: Includes the **axes.js** and **axes.min.js** files.
- **doc** folder: Includes API documentation. The home page for the documentation is **doc/index.html**.

### Linting

To keep the same code style, we adopted [TSLint](https://palantir.github.io/tslint/) to maintain our code quality.

```bash
$ npm run lint
```

### Test

Once you created a branch and done with development, you must perform a test running `npm run test` command before you push code to a remote repository.

```bash
$ npm run test
```
Running a `npm run test` command will start [Mocha](https://mochajs.org/) tests via [Karma-runner](https://karma-runner.github.io/).


## Bug Report

If you find a bug, please report it to us using the [Issues](https://github.com/naver/egjs-axes/issues) page on GitHub.


## License
egjs-axes is released under the [MIT license](https://github.com/naver/egjs-axes/blob/master/LICENSE).


```
Copyright (c) 2017 NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```