Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.54 KB

README.md

File metadata and controls

30 lines (21 loc) · 1.54 KB
Raw

anim8js

anim8 your HTML elements with jQuery

Installation

  • Bower: bower install anim8js-jquery
  • Node: npm install anim8js-jquery
  • Download: anim8js-jquery

jQuery Functions

A few functions are available for jQuery which will help you animate jQuery objects:

  • m8/anim8/animator: returns an animator instance for the first element in the jQuery object.
  • m8s/anim8s/animators: returns animators for all elements in the jQuery object.
  • dataPlay: plays the animation specified in the data-... attribute for all elements in the jQuery object and returns a jQuery object which contains only elements that had a valid animation to play.
  • dataQueue: queues the animation specified in the data-... attribute for all elements in the jQuery object and returns a jQuery object which contains only elements that had a valid animation to queue.
  • dataTransition: transitions into the animation specified in the data-... attribute for all elements in the jQuery object and returns a jQuery object which contains only elements that had a valid animation to transition into.

For example if you have the following HTML:

<div id="box" data-intro="fadeIn ~5s" data-outro="flipOutX 0.5s">Hello World!</div>

You can play the specified animations with...

$('#box').dataPlay('intro').dataQueue('outro');