Skip to content

guanyang/open-agent-hub / skills/remotion

remotion-best-practices

Verified

Best practices and domain knowledge for building videos programmatically with Remotion (videos in React/TypeScript, rendered to MP4). Use whenever writing or editing Remotion code — scaffolding a video project, animating with interpolate/spring over useCurrentFrame(), sequencing scenes and transitions, captions/subtitles, audio, GIFs/Lottie/3D, charts, visual effects, dynamic duration via calculateMetadata, or rendering. Consult before reaching for a Remotion API, since its components and props evolve (e.g. @remotion/media).

FileKindSize
SKILL.mdskill md12.0 KB
rules/3d.mdmarkdown2.2 KB
rules/animations.mdmarkdown1.1 KB
rules/assets.mdmarkdown1.6 KB
rules/assets/charts-bar-chart.tsxother3.3 KB
rules/assets/text-animations-typewriter.tsxother2.1 KB
rules/assets/text-animations-word-highlight.tsxother2.3 KB
rules/audio-visualization.mdmarkdown4.8 KB
rules/audio.mdmarkdown3.5 KB
rules/calculate-metadata.mdmarkdown3.2 KB
rules/can-decode.mdmarkdown1.6 KB
rules/charts.mdmarkdown2.9 KB
rules/compositions.mdmarkdown3.3 KB
rules/display-captions.mdmarkdown5.3 KB
rules/effects.mdmarkdown7.9 KB
rules/extract-frames.mdmarkdown5.4 KB
rules/ffmpeg.mdmarkdown1.1 KB
rules/fonts.mdmarkdown3.4 KB
rules/get-audio-duration.mdmarkdown1.3 KB
rules/get-video-dimensions.mdmarkdown1.6 KB
rules/get-video-duration.mdmarkdown1.3 KB
rules/gifs.mdmarkdown3.6 KB
rules/google-fonts.mdmarkdown1.7 KB
rules/html-in-canvas.mdmarkdown3.5 KB
rules/images.mdmarkdown1.4 KB
rules/import-srt-captions.mdmarkdown2.2 KB
rules/light-leaks.mdmarkdown2.3 KB
rules/local-fonts.mdmarkdown1.5 KB
rules/lottie.mdmarkdown1.8 KB
rules/mapbox.mdmarkdown11.0 KB
rules/maplibre.mdmarkdown12.2 KB
rules/maps.mdmarkdown11.0 KB
rules/measuring-dom-nodes.mdmarkdown973 B
rules/measuring-text.mdmarkdown2.7 KB
rules/parameters.mdmarkdown2.3 KB
rules/sequencing.mdmarkdown3.2 KB
rules/sfx.mdmarkdown1.8 KB
rules/silence-detection.mdmarkdown2.5 KB
rules/subtitles.mdmarkdown922 B
rules/tailwind.mdmarkdown420 B
rules/text-animations.mdmarkdown700 B
rules/timing.mdmarkdown5.4 KB
rules/transcribe-captions.mdmarkdown1.9 KB
rules/transitions.mdmarkdown5.7 KB
rules/transparent-videos.mdmarkdown2.2 KB
rules/trimming.mdmarkdown1.2 KB
rules/video-layout.mdmarkdown4.0 KB
rules/videos.mdmarkdown3.4 KB
rules/voiceover.mdmarkdown3.2 KB

rules/gifs.md

View on GitHub
---
name: gif
description: Displaying GIFs, APNG, AVIF and WebP in Remotion
metadata:
  tags: gif, animation, images, animated, apng, avif, webp
---

# Using Animated images in Remotion

## Basic usage

Use `<AnimatedImage>` to display a GIF, APNG, AVIF or WebP image synchronized with Remotion's timeline:

```tsx
import { AnimatedImage, staticFile } from "remotion";

export const MyComposition = () => {
  return (
    <AnimatedImage src={staticFile("animation.gif")} width={500} height={500} />
  );
};
```

Remote URLs are also supported (must have CORS enabled):

```tsx
<AnimatedImage
  src="https://example.com/animation.gif"
  width={500}
  height={500}
/>
```

## Sizing and fit

Control how the image fills its container with the `fit` prop:

```tsx
// Stretch to fill (default)
<AnimatedImage src={staticFile("animation.gif")} width={500} height={300} fit="fill" />

// Maintain aspect ratio, fit inside container
<AnimatedImage src={staticFile("animation.gif")} width={500} height={300} fit="contain" />

// Fill container, crop if needed
<AnimatedImage src={staticFile("animation.gif")} width={500} height={300} fit="cover" />
```

## Playback speed

Use `playbackRate` to control the animation speed:

```tsx
<AnimatedImage src={staticFile("animation.gif")} width={500} height={500} playbackRate={2} /> {/* 2x speed */}
<AnimatedImage src={staticFile("animation.gif")} width={500} height={500} playbackRate={0.5} /> {/* Half speed */}
```

## Looping behavior

Control what happens when the animation finishes:

```tsx
// Loop indefinitely (default)
<AnimatedImage src={staticFile("animation.gif")} width={500} height={500} loopBehavior="loop" />

// Play once, show final frame
<AnimatedImage src={staticFile("animation.gif")} width={500} height={500} loopBehavior="pause-after-finish" />

// Play once, then clear canvas
<AnimatedImage src={staticFile("animation.gif")} width={500} height={500} loopBehavior="clear-after-finish" />
```

## Styling

Use the `style` prop for additional CSS (use `width` and `height` props for sizing):

```tsx
<AnimatedImage
  src={staticFile("animation.gif")}
  width={500}
  height={500}
  style={{
    borderRadius: 20,
    position: "absolute",
    top: 100,
    left: 50,
  }}
/>
```

## Getting GIF duration

Use `getGifDurationInSeconds()` from `@remotion/gif` to get the duration of a GIF.

```bash
npx remotion add @remotion/gif
```

```tsx
import { getGifDurationInSeconds } from "@remotion/gif";
import { staticFile } from "remotion";

const duration = await getGifDurationInSeconds(staticFile("animation.gif"));
console.log(duration); // e.g. 2.5
```

This is useful for setting the composition duration to match the GIF:

```tsx
import { getGifDurationInSeconds } from "@remotion/gif";
import { staticFile, CalculateMetadataFunction } from "remotion";

const calculateMetadata: CalculateMetadataFunction = async () => {
  const duration = await getGifDurationInSeconds(staticFile("animation.gif"));
  return {
    durationInFrames: Math.ceil(duration * 30),
  };
};
```

## Alternative

If `<AnimatedImage>` does not work (only supported in Chrome and Firefox), you can use `<Gif>` from `@remotion/gif` instead.

```bash
npx remotion add @remotion/gif # If project uses npm
bunx remotion add @remotion/gif # If project uses bun
yarn remotion add @remotion/gif # If project uses yarn
pnpm exec remotion add @remotion/gif # If project uses pnpm
```

```tsx
import { Gif } from "@remotion/gif";
import { staticFile } from "remotion";

export const MyComposition = () => {
  return <Gif src={staticFile("animation.gif")} width={500} height={500} />;
};
```

The `<Gif>` component has the same props as `<AnimatedImage>` but only supports GIF files.
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall