After Effects plugin for exporting animations to SVG + JavaScript or canvas + JavaScript
npm install bodymovinbash
with npm
npm install bodymovin
with bower
bower install bodymovin
`
Or you can use the script file from here:
https://cdnjs.com/libraries/bodymovin
Or get it directly from the AE plugin clicking on Get Player
Demo
See a basic implementation here.
Examples
See examples on codepen.
How it works
Here's a video tutorial explaining how to export a basic animation and load it in an html page
$3
- Open your AE project and select the bodymovin extension on Window > Extensions > bodymovin
- A Panel will open with a Compositions tab listing all of your Project Compositions.
- Select the composition you want to export.
- Select a Destination Folder.
- Click Render
- look for the exported json file (if you had images or AI layers on your animation, there will be an images folder with the exported files)
$3
- get the bodymovin.js file from the build/player/ folder for the latest build
- include the .js file on your html (remember to gzip it for production)
`html
`
You can call bodymovin.loadAnimation() to start an animation.
It takes an object as a unique param with:
- animationData: an Object with the exported animation data.
- path: the relative path to the animation object. (animationData and path are mutually exclusive)
- loop: true / false / number
- autoplay: true / false it will start playing as soon as it is ready
- name: animation name for future reference
- renderer: 'svg' / 'canvas' / 'html' to set the renderer
- container: the dom element on which to render the animation
It returns the animation instance you can control with play, pause, setSpeed, etc.
`js
bodymovin.loadAnimation({
container: element, // the dom element that will contain the animation
renderer: 'svg',
loop: true,
autoplay: true,
path: 'data.json' // the path to the animation json
});
`
#### Composition Settings:
Check this wiki page for an explanation for each setting.
https://github.com/bodymovin/bodymovin/wiki/Composition-Settings
Usage
Animation instances have these main methods:
$3
*
$3
*
$3
*
$3
- href: usually pass as location.href. Its useful when you experience mask issue in safari where your url does not have # symbol.
*
$3
- speed: 1 is normal speed.
*
$3
- value: numeric value.
- isFrame: defines if first argument is a time based value or a frame based (default false).
*
$3
- value: numeric value.
- isFrame: defines if first argument is a time based value or a frame based (default false).
*
$3
- direction: 1 is forward, -1 is reverse.
*
$3
- segments: array. Can contain 2 numeric values that will be used as first and last frame of the animation. Or can contain a sequence of arrays each with 2 numeric values.
- forceFlag: boolean. If set to false, it will wait until the current segment is complete. If true, it will update values immediately.
*
$3
- useSubFrames: If false, it will respect the original AE fps. If true, it will update on every requestAnimationFrame with intermediate values. Default is true.
*
$3
*
$3
- updateTextDocumentData -- updates a text layer's data
More Info
*
$3
bodymovin.play() -- with 1 optional parameter name to target a specific animation
bodymovin.stop() -- with 1 optional parameter name to target a specific animation
bodymovin.setSpeed() -- first argument speed (1 is normal speed) -- with 1 optional parameter name to target a specific animation
bodymovin.setDirection() -- first argument direction (1 is normal direction.) -- with 1 optional parameter name to target a specific animation
bodymovin.searchAnimations() -- looks for elements with class "bodymovin"
bodymovin.loadAnimation() -- Explained above. returns an animation instance to control individually.
bodymovin.destroy() -- To destroy and release resources. The DOM element will be emptied.
bodymovin.registerAnimation() -- you can register an element directly with registerAnimation. It must have the "data-animation-path" attribute pointing at the data.json url
bodymovin.setQuality() -- default 'high', set 'high','medium','low', or a number > 1 to improve player performance. In some animations as low as 2 won't show any difference.
Events
- onComplete
- onLoopComplete
- onEnterFrame
- onSegmentStart
you can also use addEventListener with the following events:
- complete
- loopComplete
- enterFrame
- segmentStart
- config_ready (when initial config is done)
- data_ready (when all parts of the animation have been loaded)
- loaded_images (when all image loads have either succeeded or errored)
- DOMLoaded (when elements have been added to the DOM)
- destroy
#### Other loading options
- if you want to use an existing canvas to draw, you can pass an extra object: 'renderer' with the following configuration:
`js
bodymovin.loadAnimation({
container: element, // the dom element
renderer: 'svg',
loop: true,
autoplay: true,
animationData: animationData, // the animation data
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)
className: 'some-css-class-name'
}
});
`
Doing this you will have to handle the canvas clearing after each frame
Another way to load animations is adding specific attributes to a dom element.
You have to include a div and set it's class to bodymovin.
If you do it before page load, it will automatically search for all tags with the class "bodymovin".
Or you can call bodymovin.searchAnimations() after page load and it will search all elements with the class "bodymovin".
- add the data.json to a folder relative to the html
- create a div that will contain the animation.
Required
. a class called "bodymovin"
. a "data-animation-path" attribute with relative path to the data.json
Optional
. a "data-anim-loop" attribute
. a "data-name" attribute to specify a name to target play controls specifically
Example
`html
`
Preview
You can preview or take an svg snapshot of the animation to use as poster. After you render your animation, you can take a snapshot of any frame in the animation and save it to your disk. I recommend to pass the svg through an svg optimizer like https://jakearchibald.github.io/svgomg/ and play around with their settings.
Recommendations
$3
If you have any images or AI layers that you haven't converted to shapes (I recommend that you convert them, so they get exported as vectors, right click each layer and do: "Create shapes from Vector Layers"), they will be saved to an images folder relative to the destination json folder.
Beware not to overwrite an exiting folder on that same location.
$3
This is real time rendering. Although it is pretty optimized, it always helps if you keep your AE project to what is necessary
More optimizations are on their way, but try not to use huge shapes in AE only to mask a small part of it.
Too many nodes will also affect performance.
$3
If you have any animations that don't work or want me to export them, don't hesitate to write.
I'm really interested in seeing what kind of problems the plugin has.
my email is hernantorrisi@gmail.com
AE Feature Support
- The script supports precomps, shapes, solids, images, null objects, texts
- It supports masks and inverted masks. Maybe other modes will come but it has a huge performance hit.
- It supports time remapping
- The script supports shapes, rectangles, ellipses and stars.
- Expressions. Check the wiki page for more info.
- Not supported: image sequences, videos and audio are not supported
- No negative layer stretching! No idea why, but stretching a layer messes with all the data.
Development
npm install or bower install first
npm start`