Types

Shared types used across the dotlottie-io API.

AnimationOptions

Passed as the third argument to addAnimation on DotLottie and DotLottieBuilder.

interface AnimationOptions {
  name?: string; // display name in the manifest
  initialTheme?: string; // ID of the theme applied by default
  background?: string; // background colour hint
  themes?: string[]; // IDs of themes associated with this animation
}

V1 playback fields (autoplay, loop, speed, direction, hover, intermission, themeColor) are intentionally absent — playback configuration lives in the player, not the file. See Managing Animations.

AssetReferences

Returned by assetReferences() on both DotLottie and DotLottieReader.

interface AssetReferences {
  images: string[];
  fonts: string[];
  audio: string[];
}

Filenames are bare basenames (e.g. "image_0.png", "cartoon.ttf"), categorized by asset type. See Querying Relationships.

Next up: Errors