lottie-js

An object model for representing the Lottie JSON structure.

This library was created to make interacting with the Lottie JSON object simpler. The library consists of methods to map the Lottie JSON to the object model and interact with properties as well as manipulate them. The goal is to fully map the Lottie object model and add in enough helper methods to the library such that Lottie manipulation can be made easier without having to learn the entire complex structure of a Lottie file.

Full Documentation is available here Click me

Usage

1. Install

yarn add @lottiefiles/lottie-js@0.0.1

1. Use

import { Animation } from '@lottiefiles/lottie-js';

async function loadAnimation() {
  // Create Lottie instance
  // (you can also use Animation.fromJSON method if you already have the Lottie JSON loaded)
  const anim = await Animation.fromURL('https://assets1.lottiefiles.com/packages/lf20_u4j3xm6r.json');

  // Print some data of the animation
  console.log('Frame Rate', anim.frameRate);
  console.log('Number of Layers', anim.layers.length);
  console.log(anim.getColors());

  // Manipulate animation
  anim.name = 'Woohoo';
  anim.width = 512;
  anim.height = 512;

  // Get the new JSON
  const woohooLottie = JSON.stringify(anim);
  console.log(woohooLottie);
}

Promise.resolve(loadAnimation());

Documentation & API

The documenting system used is TypeDoc.

Clone the repo and run the yarn command: yarn docs to generate the docs to browse locally.

The generated documentation is placed in the docs/ folder.

Testing

The testing system used is Jest and each file should have an accompanying test suite for functional and integration tests.

Development

Development work on the toolkit requires Nodejs and Yarn.

Guidelines

• Use defensive programming techniques: Ensure type and range of input values, cast values to native representation whenever possible, etc.
• Refrain from using external dependencies: Discuss before adding a dependency. Check with Bundlephobia for package size and dependencies when choosing one.
• Use code formatting in the IDE using the given eslint+prettier configs.
• Write tests to cover all functions and code branches with valid and invalid values.

Setting up

git clone https://github.com/LottieFiles/lottie-js

cd lottie-js

yarn install

Running test suite

yarn test

Building

yarn build

Changelog

0.4.2

Patch Changes

• accept nullish value in out tangets

0.4.1

Patch Changes

• typo in markers toJson

0.4.0

Minor Changes

• text layer abstractions, hotfixes and null handling on root properties, color conversion helper method, additional shape types

Patch Changes

• 047dbc2: Minor features fixes

  Improvements

  Add matteMode, matteTarget, isHidden & matchName properties to layers Add merge shape Add public parent references to layers

  Fixes

  Allow bezier tangent values to have more than 2 numbers Fix layer serialization in precomposition assets

0.2.3

Patch Changes

• e54929a: moved changesets to dev dependency All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning, enforced with semantic-release.

0.1.0 (2021-10-19)

Bug Fixes

• layer: shape layer serialization (d17188f)
• Linting issues (e88f426)
• ellipse: added missing property Direction (58bc619)
• fix import: fix import for test file (c59c1ab)

Features

• Add constructors for animated properties and keyframes (be30ed4)
• add marker support (ec26c59)
• Add rounded corners shape (589fb43)
• Add star shape (35360d6)
• Implement Gradients (ca898bd)
• Repeater shape (6b42c08)
• Trim multiple shapes mode (ba6cdad)
• color extraction updates: color extraction code (e935e00)
• theming code: theming code (c4fda3f)