flux-spring

js spring animations

npm install flux-spring

Usage

const spring = require('flux-spring');

// animate a DOM element
spring(element)
    .to({ x: 50 })
    .repeat(Infinity)
    .yoyo()
    // use flux.transform to update the
    // element with a 2d or 3d matrix
    .on('update', spring.transform)
    .start();

// animate an object's properties
spring({ x: 0 })
    .to({ x: 50 })
    // change the velocity, tension and
    // friction of the spring
    .velocity(0).tension(80).friction(8)
    .on('update', function(values) {
        console.log(values.x);
    })
    .start();

// raf loop
function tick() {
    spring.update();
    requestAnimationFrame(tick);
}
tick();

API

animation

Calling spring returns an animation. spring takes a DOM element, an object or void. The object accepts the following params: x, y, z, scaleX, scaleY, scaleZ, skewX, skewY, rotateX, rotateY, rotateZ.

const spring = require('flux-spring');
const animation = spring(elem || {});

.from(Object)

Sets the starting state. Equivalent to invoking spring with the object.

.to(Object)

Sets the end state of the animation.

.tension(Number)

Sets the tension of the spring.

.friction(Number)

Sets the friction of the spring.

.velocity(Number)

Sets the velocity of the spring.

.set(tension, friction, velocity)

Alternative to set the tensnion, friction and velocity.

.on(String, Function)

Subscribe to an event. By default, "start", "update" and "complete" events will fire when the animation starts, updates and stops.

.off(String, Function)

Unsubscribe to an event.

.trigger(String, *, *)

Triggers an event, passing the provided parameters.

.delay(Number)

ms to delay the animation after calling start.

.repeat(Number)

The number of times to repeat the animation.

.yoyo(Boolean)

Sets whether the animation should "yoyo".

.start()

Starts the animation.

statics

.transform(matrix, element)

Transforms an element by a given matrix.

.tick()

Triggers an animation tick.

.update()

Alias for .tick().

.plugin(String, Function)

Define a plugin. The plugin (Function) will be assigned to an animation on creation by name (String). The function will have access to the animation via this and returns this for chaining.

Tests

First, run npm install.

Then run npm test.

For a visual test:

npm start
localhost:1777

License

MIT License

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.