Skip to content
Tiny animation library
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo/hash-chat
dist
test Added test for step() callback Apr 13, 2016
.gitignore
LICENSE
README.md
index.js
package.json

README.md

amator

Tiny animation library.

usage

var animate = require('amator')
var from = { x: 0 }
var to = { x: 42 }

// This will animate from.x from 0 to 42 in 400ms, using cubic bezier easing
// function (same effect as default CSS `ease` function)
animate(from, to)

Overall the signature of the animate() function:

animate(fromObj, toObj, options)

options

This is a hash dictionary with the following keys:

  • duration - sets animation duration in milliseconds. Default value is 400ms;
  • easing - Easing function. Can accept predefined value similar to CSS animations: ease, easeIn, easeOut, easeInOut, linear; NOTE: You can also have a custom function instead of a string value. The function should take a single argument t from range [0..1] and return value from 0 to 1.
  • step(fromObj) - a function callback that is called after each animation frame. the only argument to this function is fromObj that has current animation values.
  • done() - a function callback that is called when animation is finished.

return value

The return value of the animate is an object, which has just one key:

  • cancel() - if you want to cancel animation before it completes, you can call this method.

license

MIT

You can’t perform that action at this time.