Renders Lottie animations via Puppeteer to image, GIF, or MP4.
Renders Lottie animations via Puppeteer to image, GIF, or MP4.
Renders Lottie animations via Puppeteer to image, GIF or MP4.
This module is also available as a CLI.
npm install --save puppeteer-lottieIf you want to generate GIFs, you must also install gifski. On macOS, you can run:
brew install gifskiIf you want to generate MP4s, you must also install ffmpeg. On macOS, you can run:
brew install ffmpeg…If you don't pass width or height, the animation's intrinsic size will be used, and if that doesn't exist it will use 640x480.
If you pass width or height, the other dimension will be inferred by maintaining the original animation's aspect ratio.
If both width and height are passed, the output will have those dimensions, but there will be extra whitespace (or transparency if rendering PNGs) due to lottie-web's default rendererSettings.preserveAspectRatio of xMidyMid meet (docs and demo).
For mp4 outputs, the height may be different by a pixel due to the x264 encoder requiring even heights.
Renders the given Lottie animation via Puppeteer.
You must pass either path or animationData to specify the Lottie animation.
output must be one of the following:
Type: function (opts): Promise
opts object Configuration optionsopts.output string Path or pattern to store resultopts.animationData object? JSON exported animation dataopts.path string? Relative path to the JSON file containing animation dataopts.width number? Optional output widthopts.height number? Optional output heightopts.jpegQuality object JPEG quality for frames (does nothing if using png) (optional, default 90)opts.quiet object Set to true to disable console output (optional, default false)opts.deviceScaleFactor number Window device scale factor (optional, default 1)opts.renderer string Which lottie-web renderer to use (optional, default 'svg')opts.rendererSettings object? Optional lottie renderer settingsopts.puppeteerOptions object? Optional puppeteer launch settingsopts.ffmpegOptions object? Optional ffmpeg settings for
crf, profileVideo and preset valuesopts.gifskiOptions object? Optional gifski settings (only for GIF outputs)opts.style object Optional JS CSS styles to apply to the animation container (optional, default {})opts.inject object Optionally injects arbitrary string content into the head, style, or body elements. (optional, default {})
opts.browser object? Optional puppeteer instance to reuseAll lottie-web features should be fully supported by the svg, canvas, and html renderers.
This includes all of the animations on lottiefiles.com!
Also see Lottie's full list of supported features.
MIT © Travis Fischer
Support my OSS work by following me on twitter
No open issues yet, or sync has not completed.