Manifest File Structure

dotLottie manages the manifest based on information and animations you provide the class with. It is not recommended to manually set or edit the manifest file.

manifest.json

The manifest file contains information about the animations that are included in the dotLottie file, including their playback settings such as autoplay, loop, direction, speed, and play mode.

The manifest file also includes metadata such as the author’s name, a description of the animation, keywords, revision number, and the version of the dotLottie file format. Additionally, there is a field for custom data, which can be used to provide any extra information to the player or animations.

Overall, the manifest file serves as a guide for developers or users who want to understand the contents of the dotLottie file and its animations. It can also be used by players that support the dotLottie format to parse and render the animations correctly.

To modify the top level settings of the manifest, access them via your DotLottie object.

To modify the animation settings, access them via the LottieAnimation object.

{
  // Optional: Default animation to play
  "activeAnimationId": string;

  // Optional: Name of the author
  "author": string | undefined;

  // Optional: Custom data to be made available to the player and animations
  "custom": Record<string, unknown>;

  // Optional: Description of the animation
  "description": string | undefined;

  // Optional: Name and version of the software that created the dotLottie
  "generator": string | undefined;

  // Optional: Description of the animation
  "keywords": string | undefined;

  // Optional: Revision version number of the dotLottie
  "revision": number | undefined;

  // Optional: Target dotLottie version
  "version": string | undefined;

  // List of animations
  "animations": [
    {
      // Optional: autoplay the animation on load
      "autoplay": boolean;

      // Optional: theme id
      "defaultTheme": string;

      // Optional: Define playback direction 1 forward, -1 backward
      "direction": number;

      // Optional
      "hover": boolean;

      // Mandatory: Unique animation id
      "id": string;

      // Optional: time in between loops
      "intermission": number;

      // Optional
      "loop": boolean;

      // Optional: Choice between 'bounce' and 'normal'
      "playMode": PlayMode;

      // Optional: Desired playback speed, default 1.0
      "speed": number;

      // Optional: Theme color
      "themeColor":  string;
    },
  ],
}