AnimationAPI/ExamplesGithub

Controls and applys various easing effects.


    Browser Support

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

    Features

    • Adjusts the range of values required to easing effect.
    • Supports shim of requestAnimationFrame, cancelAnimationFrame.
    • Supports various easing types.
    • linear
    • easeInQuad (alias: easeIn)
    • easeOutQuad (alias: easeOut)
    • easeInOutQuad (alias: easeInOut)
    • easeInCubic
    • easeOutCubic
    • easeInOutCubic
    • easeInQuart
    • easeOutQuart
    • easeInOutQuart
    • easeInQuint
    • easeOutQuint
    • easeInOutQuint
    • (Optional) Supports Promise for handling the result of animation.

    Examples

    • Basic : Example of using default options.
    • Using Promise : Example of handling the result in a browser supported Promise.

    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-animation# Latest version
    $ npm install --save tui-animation@<version> # Specific version
    bower
    $ bower install tui-animation# Latest version
    $ bower install tui-animation#<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-animation/latest/tui-animation.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-animation/
    ├─ latest/
    │  ├─ tui-animation.js
    │  └─ tui-animation.min.js
    ├─ v1.1.0/
    │  ├─ ...

    Download Source Files


    Usage

    HTML

    This component does not require the container element. You can handle the target element in the callback that is executed during the animation.

    JavaScript

    This component does not use the instance created through the constructor function. First, you should import the module using one of the following ways depending on your environment.

    Using namespace in browser environment
    var animation = tui.animation;
    
    Using module format in node environment
    var animation = require('tui-animation'); /* CommonJS */
    
    import {animation} from 'tui-animation'; /* ES6 */
    

    Then you should call the anim method with options to set configuration and call the run method to start the animation.

    var instance = animation.anim({ ... });
    
    instance.run();
    

    For more information about the API, please see here.


    Documents

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


    Contributing


    License

    This software is licensed under the MIT © NHN Entertainment.