Ecosystem: relottie Plugins

Plugins are the core mechanism for extending and customizing relottie's functionality. They are reusable modules that hook into the unified processing pipeline to inspect, analyze, or transform the LAST tree.

What Plugins Do

• Parse: Convert Lottie JSON into a LAST tree (e.g., relottie-parse).

• Transform: Modify the LAST tree. This includes:

  • Analyzing content (e.g., relottie-metadata, relottie-extract-features).

  • Changing values or structure (e.g., custom plugins you create).

  • Potentially extending syntax or adding features (e.g., relottie-style mentioned in source docs).

• Stringify/Compile: Convert the LAST tree back into Lottie JSON (e.g., relottie-stringify).

You can chain multiple plugins together using the .use() method of the relottie processor or configure them using the CLI.

Official Plugins

The @lottiefiles organization maintains several core and utility plugins:

• Core:

  • @lottiefiles/relottie-parse: Parses Lottie JSON to LAST.

  • @lottiefiles/relottie-stringify: Serializes LAST to Lottie JSON.

• Utilities:

  • @lottiefiles/relottie-metadata: Extracts metadata.

  • @lottiefiles/relottie-extract-features: Analyzes feature usage.

• Others mentioned in source:

  • relottie-style: An example plugin mentioned for extending syntax, and primarily for inspecting or changing the tree, particularly focusing on styles within Lottie animations (external link).

Finding Community Plugins

The relottie ecosystem is designed to be extensible. You can find plugins created by the community:

• Official List (Packages in Monorepo): The list of packages within the relottie monorepo includes the official plugins.

• GitHub Topic: Search for repositories tagged with the relottie-plugin topic on GitHub.

Using Third-Party Plugins

Anyone can create relottie plugins. When incorporating plugins from external sources, remember to carefully assess their quality, maintenance status, and potential security implications, just as you would with any third-party dependency. Pay special attention if the plugin deals with or modifies Lottie expressions, as noted in the Security Considerations.

Creating Your Own Plugins

If you can't find a plugin that meets your needs, you can create your own! See the Guide: Creating Plugins to learn how.