Have ideas to improve npm?Join in the discussion! »

    @egjs/rotate

    2.1.0 • Public • Published

    egjs-rotate npm version Build Status Coverage Status

    Tiny custom rotate event binder

    var handler = function(event, info) {
        ...
    };
     
    // bind rotate event
    eg.rotate.on(handler);
     
    // unbind rotate event
    eg.rotate.off(handler);
     
    // or unbind all the rotate event binds
    eg.rotate.off();

    Documents

    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

    For production (Compressed)

    You can download the compressed files for production

    Installation with npm

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

    $ npm install @egjs/rotate

    Supported Browsers

    The following are the supported browsers.

    iOS Android
    7+ 2.1+(except 3.x)

    How to start developing egjs-rotate?

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

    Development Environment

    1. Clone the repository

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

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

    2. Install dependencies

    npm is supported.

    # Install the dependency modules.
    $ npm install
    

    3. Build

    Use npm script to build eg.rotate

    # 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 rotate.js and rotate.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 ESLint to maintain our code quality. The rules are modified version based on Airbnb JavaScript Style Guide. Setup your editor for check or run below command for linting.

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

    $ npm run test

    Running a npm run test command will start Mocha tests via Karma-runner.

    Bug Report

    If you find a bug, please report it to us using the Issues page on GitHub.

    License

    egjs-rotate is released under the MIT license.

    Copyright (c) 2015 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.
    

    Keywords

    none

    Install

    npm i @egjs/rotate

    DownloadsWeekly Downloads

    94

    Version

    2.1.0

    License

    MIT <https://naver.github.io/egjs/license.txt>

    Unpacked Size

    648 kB

    Total Files

    36

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar