Este é um guia para escrever marcação React do Remotion. Se não for relevante, carregue em vez disso as Melhores Práticas do Remotion.
Preservar alterações do usuário
Os usuários podem fazer edições no código fora da conversa.
Se você detectar uma alteração surpreendente feita no meio tempo, não a sobrescreva, assuma que foi intencional ou peça confirmação.
Regras gerais
Dentro de um componente de composição ou cena, obtenha fps de useVideoConfig() para
todos os cálculos de segundos para quadros, incluindo props de timing como from,
trimBefore, durationInFrames e premountFor. Manter a expressão no
nó JSX, como trimBefore={4 * fps}, permite que o Studio edite o timing e
mantenha-o correto se a taxa de quadros da composição mudar.
Conduza animações usando useCurrentFrame() e interpolate().
transition ou animation CSS não serão renderizados corretamente, eles precisam ser refatorados.
A classe de animação Tailwind não será renderizada corretamente, ela precisa ser refatorada.
Use Easing.bezier() e Easing.spring() para personalizar o timing.
Estruture sua marcação de acordo com as Melhores Práticas de Interatividade do Remotion.
Prefira Interactive.withSchema({wrapInSequence: true}) para componentes visuais personalizados
com props editáveis, e registre cenas reutilizáveis como composições conectadas.
Coloque o timing diretamente nos componentes que o suportam; evite wrappers <Sequence> redundantes.
Dê a cada componente temporizado que suporta premountFor um segundo de premontagem:
premountFor={fps}, onde fps vem de useVideoConfig(). Aplique isso a
mídia, componentes interativos, <Sequence>, <Series.Sequence>,
<TransitionSeries.Sequence> e <TransitionSeries.Overlay>, incluindo
componentes temporizados aninhados dentro de cenas. Premonte o item da timeline pai também
quando um item aninhado precisar ser montado antes do pai começar. Um componente sem
premountFor, como <TransitionSeries.Transition>, não precisa de substituto.
O Studio edita o nó fonte JSX que criou um item. Crie cada registro de composição, clipe, cena, camada e sequência que deva ser editável independentemente como seu próprio nó JSX, com suas props editáveis inline. Loops programáticos são adequados quando as instâncias geradas são intencionalmente controladas como um modelo de fonte único, não quando os usuários precisam editar as instâncias separadamente.
import { useCurrentFrame, useVideoConfig, Easing, interpolate, Interactive } from "remotion";
export const FadeIn = () => {
const frame = useCurrentFrame();
const {fps} = useVideoConfig();
return (
<Interactive.Div
name="Title"
premountFor={fps}
style={{
opacity: interpolate(frame, [0, 2 * fps], [0, 1], {
extrapolateRight: "clamp",
extrapolateLeft: "clamp",
easing: Easing.bezier(0.16, 1, 0.3, 1),
}),
}}
>
Hello World!
</Interactive.Div>
);
};
Mantenha a chamada interpolate() inline no prop style.
Use as propriedades CSS scale, translate, rotate em vez de transform.
// 👍 Keyframes editáveis inline e atalhos de transformação
style={{
scale: interpolate(frame, [0, 100], [0, 1], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
output: 'perceptual-scale' // Para animações de `scale`, use "output: 'perceptual-scale'"
}),
translate: interpolate(frame, [0, 100], ["0px 0px", "100px 100px"], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
}),
rotate: interpolate(frame, [0, 100], ["20deg", "90deg"], {
extrapolateLeft: 'clamp',
extrapolateRight: 'clamp',
easing: Easing.spring({damping: 200}),
}),
}}
// 👎 Valores não inline e strings de transformação se tornam mais difíceis de editar no Studio
const scale = interpolate(frame, [0, 100], [0, 1]);
style={{
transform: `scale(${scale})`,
}}
Assets
Coloque os assets na pasta public/ na raiz do seu projeto.
Use staticFile() para referenciar arquivos da pasta public/.
Componentes de mídia
Adicione vídeo e áudio usando <Video> e <Audio> de @remotion/media.
Adicione imagens usando o componente <CanvasImage>.
Adicione GIFs animados, APNG, WebP ou imagens AVIF usando <AnimatedImage>, use @remotion/gif se não estiver usando Chrome.
Use staticFile() para arquivos em public/ ou passe uma URL remota diretamente:
import { Audio, Video } from "@remotion/media";
import { staticFile, CanvasImage, AnimatedImage, useVideoConfig } from "remotion";
export const MyComposition = () => {
const {fps} = useVideoConfig();
return (
<>
<Video src={staticFile("video.mp4")} premountFor={fps} style={{ opacity: 0.5 }} />
<Audio src={staticFile("audio.mp3")} premountFor={fps} />
<CanvasImage
src={staticFile("logo.png")}
premountFor={fps}
style={{ width: 100, height: 100 }}
/>
<Video src="https://remotion.media/video.mp4" premountFor={fps} />
<AnimatedImage src={staticFile('nyancat.gif')} premountFor={fps} />
</>
);
};
Se a composição for principalmente uma linha do tempo de clipes de vídeo ou áudio, leia video-editing.md antes de escolher sua estrutura de fonte.
Cena de exemplo
Um vídeo de fundo com um terço inferior.
O terço inferior é um componente interativo com sua própria linha do tempo, registrado como uma composição conectada.
Seu texto é passado como children e accentColor é uma prop editável.
O fade-in é animado inline no local da chamada.
// MyScene.tsx
import { Video } from "@remotion/media";
import { Easing, interpolate, useCurrentFrame, useVideoConfig } from "remotion";
import { LowerThird } from "./LowerThird";
export const MyScene = () => {
const { fps } = useVideoConfig();
const frame = useCurrentFrame();
return (
<>
<Video
name="Background"
src="https://remotion.media/video.mp4"
premountFor={fps}
objectFit="cover"
style={{
position: "absolute",
width: "100%",
height: "100%",
}}
/>
<LowerThird
name="Lower third"
from={1 * fps}
premountFor={fps}
accentColor="#0b84f3"
style={{
opacity: interpolate(frame, [1 * fps, 2 * fps], [0, 1], {
extrapolateRight: "clamp",
extrapolateLeft: "clamp",
easing: Easing.bezier(0.16, 1, 0.3, 1),
}),
}}
>
Jane Doe, Product Designer
</LowerThird>
</>
);
};
// LowerThird.tsx
import type React from "react";
import { Interactive, type InteractivitySchema } from "remotion";
type LowerThirdProps = {
readonly children: string;
readonly accentColor: string;
readonly style?: React.CSSProperties;
};
const LowerThirdInner: React.FC<LowerThirdProps> = ({
children,
accentColor,
style,
}) => {
return (
<Interactive.Div
style={{
position: "absolute",
left: 80,
bottom: 80,
display: "flex",
alignItems: "center",
gap: 20,
backgroundColor: "white",
borderRadius: 16,
padding: "20px 32px",
color: "black",
fontFamily: "Helvetica, Arial, sans-serif",
fontSize: 48,
fontWeight: 600,
...style,
}}
>
<div
style={{
width: 8,
alignSelf: "stretch",
borderRadius: 4,
backgroundColor: accentColor,
}}
/>
{children}
</Interactive.Div>
);
};
const lowerThirdSchema = {
children: { type: "text-content", default: "", description: "Texto" },
accentColor: {
type: "color",
default: "#0b84f3",
description: "Cor de destaque",
},
} as const satisfies InteractivitySchema;
export const LowerThird = Interactive.withSchema({
Component: LowerThirdInner,
componentName: "<LowerThird>",
schema: lowerThirdSchema,
wrapInSequence: true,
});
// Root.tsx
import { Composition } from "remotion";
import { LowerThird } from "./LowerThird";
import { MyScene } from "./MyScene";
export const RemotionRoot: React.FC = () => {
return (
<>
<Composition
id="MyScene"
component={MyScene}
durationInFrames={60}
fps={30}
width={1280}
height={720}
/>
<Composition
id="LowerThird"
component={LowerThird}
durationInFrames={30}
fps={30}
width={1280}
height={720}
defaultProps={{
children: "Jane Doe, Product Designer",
accentColor: "#0b84f3",
}}
/>
</>
);
};
Atraso, corte
Coloque o timing diretamente nos componentes que o suportam. Veja Props de timing para as props suportadas, exemplos e ordem de operações.
Mapas
Veja Mapas do Remotion se quiser incluir mapas no vídeo.
Destaques e anotações de texto
Veja text-highlights.md para destaques de texto (marcadores de destaque), círculos, sublinhados, tachados, texto riscado, caixas.
Vídeos com várias cenas
Veja multi-scene-video.md se planeja fazer um vídeo com várias cenas subsequentes.
Composições conectadas
Quando uma cena ou grupo de camadas merece sua própria linha do tempo editável, siga connected-compositions.md. Prefira esta estrutura para cenas substanciais em um vídeo de múltiplas cenas.
Ação de pré-composição
Para uma solicitação do Studio como Pré-compor Brilho ambiente (src/BarChart.tsx:134), encontre a marcação da sequência selecionada no local informado. Crie uma composição conectada, seguindo connected-compositions.md: extraia a marcação para um componente nomeado, de preferência torne-o interativo com Interactive.withSchema({wrapInSequence: true}), e registre a mesma referência de componente exportada com um <Composition> único na raiz. Renderize o componente interativo diretamente com suas props de timing, ou como o único filho de uma sequência quando esse wrapper tiver um propósito. Se o nó selecionado já for uma sequência, mantenha suas props e extraia seus filhos. O registro precisa de dimensões, fps, duração e defaultProps equivalentes ao seu uso pai. Uma extração de componente sem uma composição registrada não completa uma solicitação de pré-composição.
Carregue estilos herdados como fontFamily e carregamento de fonte no componente extraído;
veja independência do pai.
Narração
Veja voiceover.md para adicionar narração gerada por IA às composições do Remotion usando ElevenLabs TTS.
Incorporação de vídeos
Veja embedding-videos.md para conhecimento avançado sobre incorporação de vídeos - corte, volume, velocidade, loop, pitch.
Incorporação de áudio
Veja audio.md para recursos avançados de áudio como corte, volume, velocidade, pitch.
Corte de imagem
Veja cropping.md se precisar cortar o retângulo visível de um componente.
Transições
Veja transitions.md para padrões de transição de cena.
Desfoque de movimento
Ao adicionar desfoque de movimento ou um rastro de movimento, leia motion-blur.md para a abordagem preferida de HTML em canvas, requisitos de visualização e alternativas.
Efeitos visuais e de pixel
Ao criar um efeito visual, considere se é viável usando CSS e HTML, ou se um shader é necessário.
Ordem de preferência:
- HTML + CSS regular ou outras técnicas web
- Um efeito aplicado diretamente ao elemento (
<Video>,<Img>), ou envolvendo o conteúdo em<HtmlInCanvas>, que também aceitaeffects:
- Um efeito listado via effects.md
- Um
createEffect()personalizado via effects.md quando nenhum preset estiver disponível.
Conteúdo 3D
Veja ./3d.md para conteúdo 3D no Remotion usando Three.js e React Three Fiber.
Efeitos sonoros
Quando precisar usar efeitos sonoros, carregue o arquivo ./sfx.md para mais informações.
Visualização de áudio
Quando precisar visualizar áudio (barras de espectro, formas de onda, efeitos reativos a graves), carregue o arquivo ./audio-visualization.md para mais informações.
Mapas
Para mapas estáticos, rotas animadas e marcadores, explicadores geográficos, Mapbox, MapLibre, MapTiler, GeoJSON ou sobrevoos geográficos 3D, carregue Mapas do Remotion.
Legendas
Ao lidar com legendas ou subtítulos, carregue o skill de Legendas do Remotion para mais informações.
Google Fonts
É a maneira recomendada de carregar fontes no Remotion. Veja google-fonts.md para saber como carregar Google Fonts.
Fontes locais
Veja local-fonts.md para saber como carregar fontes locais.
GIFs
Veja gifs.md para saber como exibir GIFs sincronizados com a linha do tempo do Remotion.
Imagens avançadas
Veja images.md para dimensionamento e posicionamento de imagens, caminhos dinâmicos de imagem e obtenção de dimensões de imagem.
Animações Lottie
Veja lottie.md para incorporar animações Lottie no Remotion.
Timing
Veja timing.md para mais técnicas de timing para interpolate().
Vídeos parametrizados
Veja parameters.md para tornar uma composição parametrizável adicionando um esquema Zod.
Medição de nós DOM
Veja measuring-dom-nodes.md para medir dimensões de elementos DOM no Remotion.
Medição de texto
Veja measuring-text.md para medir dimensões de texto, ajustar texto a contêineres e verificar estouro.
Usando FFmpeg
Para algumas operações de vídeo, como cortar vídeos ou detectar silêncio, o FFmpeg deve ser usado. Carregue o arquivo ./ffmpeg.md para mais informações.
Detecção de silêncio
Quando precisar detectar e cortar segmentos silenciosos de arquivos de vídeo ou áudio, carregue o arquivo ./silence-detection.md.
Duração dinâmica, dimensões e dados
Veja calculate-metadata.md para definir dinamicamente a duração, dimensões e props de uma composição com calculateMetadata().
Entrada de dados
Veja input-props.md para entrada de dados externos, como dados JSON de APIs ou um arquivo local.
Política de segurança de conteúdo (CSP)
Se o vídeo for reproduzido em um ambiente com CSP, carregue csp.md para garantir que os recursos sejam carregados corretamente.
Cache e desempenho
Veja cache-and-perf.md para dicas de desempenho e estratégias de cache.
Comportamento de fallback
Veja fallback-behavior.md para entender como o Remotion lida com componentes não encontrados ou props ausentes.
Uso de Hooks
Veja hooks.md para uma lista de hooks disponíveis no Remotion.
Uso de contextos
Veja contexts.md para usar React Contexts com Remotion.
Uso de Suspense
Veja suspense.md para usar React Suspense com Remotion.
Uso de Error Boundaries
Veja error-boundaries.md para usar Error Boundaries com Remotion.
Uso de Portais
Veja portals.md para usar Portais React com Remotion.
Uso de Ref's
Veja refs.md para usar refs React com Remotion.
Uso de Memo
Veja memo.md para usar React.memo com Remotion.
Uso de Lazy Loading
Veja lazy-loading.md para carregar componentes lentamente no Remotion.
Uso de Fragmentos
Veja fragments.md para usar Fragmentos React com Remotion.
Uso de Strict Mode
Veja strict-mode.md para usar React Strict Mode com Remotion.
Uso de Componentes de Classe
Veja class-components.md para usar componentes de classe React com Remotion.
Uso de Componentes Funcionais
Veja functional-components.md para usar componentes funcionais React com Remotion.
Uso de Hooks Personalizados
Veja custom-hooks.md para criar hooks personalizados com Remotion.
Uso de Render Props
Veja render-props.md para usar render props com Remotion.
Uso de High Order Components
Veja high-order-components.md para usar componentes de alta ordem com Remotion.
Uso de Contextos Personalizados
Veja custom-contexts.md para criar contextos personalizados com Remotion.
Uso de Middleware
Veja middleware.md para usar middleware com Remotion.
Uso de Plugins
Veja plugins.md para usar plugins com Remotion.
Uso de Extensões
Veja extensions.md para usar extensões com Remotion.
Uso de Temas
Veja themes.md para usar temas com Remotion.
Uso de Estilos Globais
Veja global-styles.md para usar estilos globais com Remotion.
Uso de Estilos CSS Modules
Veja css-modules.md para usar CSS Modules com Remotion.
Uso de Estilos Styled Components
Veja styled-components.md para usar Styled Components com Remotion.
Uso de Estilos Emotion
Veja emotion.md para usar Emotion com Remotion.
Uso de Estilos Tailwind
Veja tailwind.md para usar Tailwind CSS com Remotion.
Uso de Estilos Sass
Veja sass.md para usar Sass com Remotion.
Uso de Estilos Less
Veja less.md para usar Less com Remotion.
Uso de Estilos PostCSS
Veja postcss.md para usar PostCSS com Remotion.
Uso de Estilos CSS-in-JS
Veja css-in-js.md para usar CSS-in-JS com Remotion.
Uso de Estilos com Frameworks
Veja framework-styles.md para usar estilos de frameworks com Remotion.
Uso de Animação CSS
Veja css-animation.md para usar animação CSS com Remotion.
Uso de Animações SVG
Veja svg-animation.md para usar animações SVG com Remotion.
Uso de Animações Canvas
Veja canvas-animation.md para usar animações Canvas com Remotion.
Uso de Animações WebGL
Veja webgl-animation.md para usar animações WebGL com Remotion.
Uso de Animações com Biblioteca
Veja library-animations.md para usar animações de bibliotecas com Remotion.
Uso de Transições com Biblioteca
Veja library-transitions.md para usar transições de bibliotecas com Remotion.
Uso de Efeitos com Biblioteca
Veja library-effects.md para usar efeitos de bibliotecas com Remotion.
Uso de Componentes com Biblioteca
Veja library-components.md para usar componentes de bibliotecas com Remotion.
Uso de Hooks com Biblioteca
Veja library-hooks.md para usar hooks de bibliotecas com Remotion.
Uso de Contextos com Biblioteca
Veja library-contexts.md para usar contextos de bibliotecas com Remotion.
Uso de Middleware com Biblioteca
Veja library-middleware.md para usar middleware de bibliotecas com Remotion.
Uso de Plugins com Biblioteca
Veja library-plugins.md para usar plugins de bibliotecas com Remotion.
Uso de Extensões com Biblioteca
Veja library-extensions.md para usar extensões de bibliotecas com Remotion.
Uso de Temas com Biblioteca
Veja library-themes.md para usar temas de bibliotecas com Remotion.
Uso de Estilos com Biblioteca
Veja library-styles.md para usar estilos de bibliotecas com Remotion.
Uso de Animações com Biblioteca
Veja library-animations.md para usar animações de bibliotecas com Remotion.
Uso de Transições com Biblioteca
Veja library-transitions.md para usar transições de bibliotecas com Remotion.
Uso de Efeitos com Biblioteca
Veja library-effects.md para usar efeitos de bibliotecas com Remotion.
Uso de Componentes com Biblioteca
Veja library-components.md para usar componentes de bibliotecas com Remotion.
Uso de Hooks com Biblioteca
Veja library-hooks.md para usar hooks de bibliotecas com Remotion.
Uso de Contextos com Biblioteca
Veja library-contexts.md para usar contextos de bibliotecas com Remotion.
Uso de Middleware com Biblioteca
Veja library-middleware.md para usar middleware de bibliotecas com Remotion.
Uso de Plugins com Biblioteca
Veja library-plugins.md para usar plugins de bibliotecas com Remotion.
Uso de Extensões com Biblioteca
Veja library-extensions.md para usar extensões de bibliotecas com Remotion.
Uso de Temas com Biblioteca
Veja library-themes.md para usar temas de bibliotecas com Remotion.
Uso de Estilos com Biblioteca
Veja library-styles.md para usar estilos de bibliotecas com Remotion.