ember-animation-box

0.0.8 • Public • Published

npm version Build Status

ember-animation-box

For most your Ember animation needs, you should turn to liquid-fire. ember-animation-box provides a much more limited feature set, but also a more dynamic API. You can pass transitions into it at runtime, rather than having to hard-code them into a transitions.js file. For most web applications, liquid-fire is the safer choice, but we needed something a little more flexible for the Affinity Engine game engine.

Installation

ember install ember-animation-box

Usage

The ember-animation-box should wrap the content you want to animate:

{{#ember-animation-box transitions=transitions animationAdapter="velocity"}}
  <h1>My Html</h1>
  {{my-component}}
{{/ember-animation-box}}

animationAdapter

The animationAdapter let's you specify which animation library this box should use. It defaults to using jquery, which won't actually animate the transitions. (It simply changes the css values.) The only other adapter build-in to ember-animation-box is 'velocity', which uses Velocity.js. You'll still need to include Velocity in your repo to use it, perhaps through the ember-cli-velocity addon.

transitions

The transitions param should be an Ember.A of transition objects. Currently, ember-animation-box supports three types of transitions:

Standard Transitions

{
  duration: 100, // in millliseconds
  otherOptions: 'foobar',
  effect: {
    opacity: 0.7
    width: '50px'
  }
}

The standard transition contains an effect object, which has an array of css attributes/values. Outside of the effect object you can pass in additional options supported by your animation library, such as duration.

Cross Fade

{
  crossFade: {
    cb() {
      . . . .
    },
    in: {
      duration: 500,
      effect: {
        opacity: 1
      }
    },
    out {
      duration: 250,
      effect: {
        opacity: 0
      }
    }
  }
}

If the transition contains a crossFade object, then it'll clone the current content of your animation box and perform the out transition on it. It'll also executes cb before performing the in animation, which is the ideal time to change the content of your animation box so that the new content appears to transition in.

Delay

{
  duration: 100
}

To get a simple delay before the next transition, provide a transition without an effect or crossFade object.

AnimatableMixin

Alternatively, you can apply the AnimatableMixin directly to a component, which will make it expose the same API as the ember-animation-box. The one limitation of this approach is that it cannot crossfade:

import Ember from 'ember';
import { AnimatableMixin } from 'ember-animation-box';
 
export default Ember.Component.extend(AnimatableMixin, {
  . . . .
});
 

Readme

Keywords

Package Sidebar

Install

npm i ember-animation-box

Weekly Downloads

1

Version

0.0.8

License

MIT

Last publish

Collaborators

  • nullnullnull