Miss any of our Open RFC calls?Watch the recordings here! »

ember-cli-bodymovin

0.1.5 • Public • Published

NPM downloads Circle CI Status Code Climate Coverage Status Ember Observer Score

ember-cli-bodymovin

A little wrapper for Bodymovin, an After Effects plugin for exporting animations to svg/canvas/html + js.

Installation

ember install ember-cli-bodymovin

Usage

Rendering your animation out of AE using the bodymovin extension will generate a json representation of your animation. COol.

All you need to do is drop your animation file into your app's public dir public/animations/coolFileName.json and it's ready to use.

Basic usage

{{body-movin path='coolFileName'}}

External Files

Sometimes you may need or want to host your animation json somewhere else. No problem, just set external=true and include the full path.

{{body-movin
    path='https://jklb-os.s3.amazonaws.com/bodymovin/menu.json'
    external=true}}

Interacting with your animation

You can use any of the Bodymovin.js primitives in your Component/Controller. Check them out.

I'm providing a couple basic features that should help you get things going quickly. Please submit an issue if I'm missing something obvious!

Reverse

Reverse the play direction on click. This is useful for menu animations. It simply will flip the play direction on click.

{{ body-movin path='menu' clickAction='reverse' loop=false autoplay=false }}

reverse preview

Play / Pause

Toggling the play state seems like a thing people would want to do. I think? Idk but here it is:

{{ body-movin path='reel' clickAction='playPause' }}
 

playPause preview

Create your own

You have the power to create your own actions- just hook into the click event.

{{!-- templates/component/playPause-animation.hbs --}}
 
{{ body-movin path='reel' setup=(action setup) click=(action playPause) }}
 
// component/playPause-animation.js
 
import Ember from 'ember';
 
export default Ember.Component.extend({
  animation: null,
  state: {
    playing: true
  },
 
  actions: {
    setup(data) {
      this.set('animation', data);
    },
 
    playPause() {
      let state = this.get('state');
      let animation = this.get('animation');
 
      if (state.playing) {
        animation.pause();
        this.set('state.playing', false);
      } else {
        animation.play();
        this.set('state.playing', true);
      }
    }
 
  }
 
});
 

Options

You can override all the default stuff as you'd expect.

{{body-movin
    path='loading'
    renderStyle='canvas'
    autoplay=false
    autorender=true
    rendererSettings=myRendererSettings
    clickAction="playPause" // playPause or reverse
    click=(action 'submit') // Handle in your component/controller
    setup=(action 'mySetup') // Handle in your component/controller
}}

animation (String)

The file name OR url of your animation.

external (Boolean)

Set this to true if you're including an external source as your path.

renderType (String)

Set to 'svg' / 'canvas' / 'html' to set the renderer. If you leave it of, we'll default to our favorite- SVG.

rendererSettings (Object)

Some additional renderer settings for max control.

rendererSettings: {
  context: canvasContext, // the canvas context
  scaleMode: 'noScale',
  clearCanvas: false,
  progressiveLoad: false, // Boolean, only svg renderer, loads dom elements when needed. Might speed up initialization for large number of elements.
  hideOnTransparent: true //Boolean, only svg renderer, hides elements when opacity reaches 0 (defaults to true)
}

loop (String)

true / false / number

autoplay (Boolean)

true / false

Contributing

Hook it up!

Running

Running Tests

  • npm test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

For more information on using ember-cli, visit http://ember-cli.com/.

Keywords

Install

npm i ember-cli-bodymovin

DownloadsWeekly Downloads

56

Version

0.1.5

License

MIT

Last publish

Collaborators

  • avatar