animate-helper

Animate Helper

Provide functions to handle animations and transitions gracefully. Execute a function before or after playing a css animation on an element.

Installation

Setting up is pretty straight-forward. Just download the script from dist folder and include it in your HTML:

<script type="text/javascript" src="path/to/dist/animation-helper.min.js"></script>

NPM

Require Bundle is also available on NPM:

$ npm install animate-helper

Basic Usage

1. Execute a function BEFORE playing a css animation

Call the function AnimateHelper.doThenAnimate( element, animationClass, callbackFn ); passing the parameters:

• element: The element to which the animation class will be added and the animation played on
• animationClass: The class name for the animation which should have the css property animation: set to a css keyframe animation definition.
• callbackFn: The function to execute before the animation is played, accepts the parameters element and animationClass.

// Set element open then play openning animation
AnimateHelper.doThenAnimate( document.querySelector( '.flyout-menu' ), 'slide-up', function( element, animationClass ) {
    element.style.display = 'block';
    document.body.classList.add( 'flyout-menu--open' );
} );

2. Execute a function AFTER playing a css animation

Call the function AnimateHelper.animateThenDo( element, animationClass, callbackFn ); passing the parameters:

• element: The element to which the animation class will be added and the animation played on
• animationClass: The class name for the animation which should have the css property animation: set to a css keyframe animation definition.
• callbackFn: The function to execute after the animation is played (animationend event), accepts the parameters element and animationClass.

// Play closing animation then set element hidden
AnimateHelper.animateThenDo( document.querySelector( '.flyout-menu' ), 'slide-down', function( element, animationClass ) {
    element.style.display = 'none';
    document.body.classList.remove( 'flyout-menu--open' );
} );

Contributing to Development

This isn't a large project by any means, but you are definitely welcome to contribute.

Development environment

Clone the repo and run npm install:

$ cd path/to/animate-helper
$ npm install

Run the build command:

$ gulp build

Build on file save:

$ gulp
$ gulp watch

License

Licensed under MIT.