Skip to content

🎥 Make videos programmatically with React

Elements: Simplify template preview types and improve spacing

Igor Samokhovetsa1f4017bfe69
diff --git a/packages/template-element-library/app/components/category-navigation.tsx b/packages/template-element-library/app/components/category-navigation.tsx
index 023e2b127b..4396b3ac0b 100644
--- a/packages/template-element-library/app/components/category-navigation.tsx
+++ b/packages/template-element-library/app/components/category-navigation.tsx
@@ -16,6 +16,7 @@ export const CategoryNavigation = ({
>
{[null, ...categories].map((item) => {
const params = new URLSearchParams(search);
+
if (item === null || item === "Captions") {
params.delete("category");
} else {
diff --git a/packages/template-element-library/app/components/element-preview.tsx b/packages/template-element-library/app/components/element-preview.tsx
index e85e65144d..167e4a7ac3 100644
--- a/packages/template-element-library/app/components/element-preview.tsx
+++ b/packages/template-element-library/app/components/element-preview.tsx
@@ -1,5 +1,5 @@
import { Player } from "@remotion/player";
-import { useMemo, type CSSProperties } from "react";
+import { useMemo } from "react";
import type { ElementDefinition } from "../../elements/registry";
import { ElementPreview as PreviewComposition } from "../../remotion/ElementPreview";
@@ -13,6 +13,11 @@ export const ElementPreview = ({
[definition.slug],
);
+ const style = {
+ width: "100%",
+ "--preview-background": definition.previewBackground,
+ };
+
return (
<Player
component={PreviewComposition}
@@ -25,12 +30,7 @@ export const ElementPreview = ({
controls
loop
className="bg-(--preview-background)"
- style={
- {
- width: "100%",
- "--preview-background": definition.previewBackground,
- } as CSSProperties
- }
+ style={style}
/>
);
};
diff --git a/packages/template-element-library/app/components/rendered-preview.tsx b/packages/template-element-library/app/components/rendered-preview.tsx
index 010f6b2ad1..9ad75958c3 100644
--- a/packages/template-element-library/app/components/rendered-preview.tsx
+++ b/packages/template-element-library/app/components/rendered-preview.tsx
@@ -2,6 +2,8 @@ import { useEffect, useRef, useState } from "react";
import type { ElementDefinition } from "../../elements/registry";
import previews from "../../elements/previews.json";
+const previewsBySlug = new Map(Object.entries(previews));
+
export const RenderedPreview = ({
definition,
playing,
@@ -9,9 +11,7 @@ export const RenderedPreview = ({
definition: ElementDefinition;
playing: boolean;
}) => {
- const assets = (
- previews as Record<string, { posterUrl: string; videoUrl: string }>
- )[definition.slug];
+ const assets = previewsBySlug.get(definition.slug);
const video = useRef<HTMLVideoElement>(null);
const [reducedMotion, setReducedMotion] = useState(true);
const [failed, setFailed] = useState(false);
@@ -22,6 +22,7 @@ export const RenderedPreview = ({
const update = () => setReducedMotion(preference.matches);
update();
preference.addEventListener("change", update);
+
return () => preference.removeEventListener("change", update);
}, []);
@@ -31,11 +32,13 @@ export const RenderedPreview = ({
useEffect(() => {
const element = video.current;
+
if (!element) return;
let canceled = false;
element.play().catch(() => {
if (!canceled) setFailed(true);
});
+
return () => {
canceled = true;
element.pause();
diff --git a/packages/template-element-library/app/components/studio-actions.tsx b/packages/template-element-library/app/components/studio-actions.tsx
index 529f63df69..7c2fd83c00 100644
--- a/packages/template-element-library/app/components/studio-actions.tsx
+++ b/packages/template-element-library/app/components/studio-actions.tsx
@@ -40,6 +40,7 @@ export const StudioActions = (
const sendToStudio = async () => {
setStatus({ type: "pending", message: "Finding Remotion Studio…" });
+
try {
const result = entry
? await installInStudio({ payload: entry.payload })
@@ -58,8 +59,10 @@ export const StudioActions = (
: "Request sent. Confirm in Remotion Studio to finish.",
});
setFallback({ isOpen: false, failureCount: 0 });
+
return;
}
+
setStatus({ type: "error", code: result.code, message: result.message });
} catch {
setStatus({
@@ -69,6 +72,7 @@ export const StudioActions = (
"Could not connect to Remotion Studio. Check that Studio is running, then try again.",
});
}
+
setFallback((previous) => ({
isOpen: true,
failureCount: previous.failureCount + 1,
@@ -194,6 +198,7 @@ export const StudioActions = (
onRetry={sendToStudio}
onClose={() => {
setFallback({ isOpen: false, failureCount: 0 });
+
if (status.type === "error")
setStatus({ type: "idle", message: "" });
}}
diff --git a/packages/template-element-library/app/components/studio-install-fallback.tsx b/packages/template-element-library/app/components/studio-install-fallback.tsx
index 8635039fc9..dea8d46c24 100644
--- a/packages/template-element-library/app/components/studio-install-fallback.tsx
+++ b/packages/template-element-library/app/components/studio-install-fallback.tsx
@@ -38,8 +38,10 @@ export const StudioInstallFallback = ({
useEffect(() => {
const dialog = dialogRef.current;
const trigger = triggerRef.current;
+
if (!dialog) return;
dialog.showModal();
+
return () => {
dialog.close();
window.requestAnimationFrame(() => {
@@ -51,6 +53,7 @@ export const StudioInstallFallback = ({
useEffect(() => {
if (copyStatus !== "Copied.") return;
const timeout = window.setTimeout(() => setCopyStatus(""), 2000);
+
return () => window.clearTimeout(timeout);
}, [copyStatus]);
@@ -66,6 +69,7 @@ export const StudioInstallFallback = ({
onClick={(event) => {
if (event.target !== event.currentTarget) return;
const bounds = event.currentTarget.getBoundingClientRect();
+
if (
event.clientX < bounds.left ||
event.clientX > bounds.right ||
diff --git a/packages/template-element-library/app/root.tsx b/packages/template-element-library/app/root.tsx
index ddf900a369..3ac1abdf23 100644
--- a/packages/template-element-library/app/root.tsx
+++ b/packages/template-element-library/app/root.tsx
@@ -41,6 +41,7 @@ export function HydrateFallback() {
export function ErrorBoundary() {
const error = useRouteError();
const notFound = isRouteErrorResponse(error) && error.status === 404;
+
return (
<main
id="main"
diff --git a/packages/template-element-library/app/routes/element.tsx b/packages/template-element-library/app/routes/element.tsx
index 83d0e5740f..46c1e697b7 100644
--- a/packages/template-element-library/app/routes/element.tsx
+++ b/packages/template-element-library/app/routes/element.tsx
@@ -14,6 +14,7 @@ export const meta: MetaFunction = ({ params }) => {
const entry = catalog.find(
({ definition }) => definition.slug === params.slug,
);
+
return [
{
title: `${entry?.definition.displayName ?? "Element not found"} — Studio Supply`,
@@ -30,6 +31,7 @@ export default function ElementPage() {
const { search } = useOutletContext<{ search: string }>();
const [copyStatus, setCopyStatus] = useState("");
const entry = catalog.find(({ definition }) => definition.slug === slug);
+
if (!entry) {
return (
<main id="main" className="py-16">
@@ -50,6 +52,7 @@ export default function ElementPage() {
</main>
);
}
+
const { definition, sourceCode } = entry;
return (
diff --git a/packages/template-element-library/app/routes/layout.tsx b/packages/template-element-library/app/routes/layout.tsx
index 85d5b67914..6571ee3f42 100644
--- a/packages/template-element-library/app/routes/layout.tsx
+++ b/packages/template-element-library/app/routes/layout.tsx
@@ -8,9 +8,11 @@ export default function LibraryLayout() {
const [hydrated, setHydrated] = useState(false);
const search = hydrated ? location.search : "";
const [insideStudio, setInsideStudio] = useState(false);
+
const isCaptionPicker =
insideStudio &&
new URLSearchParams(search).get("remotion-studio-context") === "captions";
+
useEffect(() => {
setHydrated(true);
setInsideStudio(isInsideStudio());
diff --git a/packages/template-element-library/app/routes/library.tsx b/packages/template-element-library/app/routes/library.tsx
index 81a3e0ac26..ca2b14bb9c 100644
--- a/packages/template-element-library/app/routes/library.tsx
+++ b/packages/template-element-library/app/routes/library.tsx
@@ -15,13 +15,16 @@ export const meta: MetaFunction = () => [
export default function Library() {
const { search } = useOutletContext<{ search: string }>();
const searchParams = new URLSearchParams(search);
+
const categories = [
...new Set(catalog.map(({ definition }) => definition.category)),
];
+
const category =
categories.find(
(item) => item.toLowerCase() === searchParams.get("category"),
) ?? null;
+
const visible = catalog.filter(
({ definition }) => category === null || definition.category === category,
);
diff --git a/packages/template-element-library/elements/accent-captions/accent-captions.tsx b/packages/template-element-library/elements/accent-captions/accent-captions.tsx
index b53f59532e..324112130b 100644
--- a/packages/template-element-library/elements/accent-captions/accent-captions.tsx
+++ b/packages/template-element-library/elements/accent-captions/accent-captions.tsx
@@ -19,6 +19,7 @@ const AccentCaptionsInner = ({
}: AccentCaptionsProps) => {
const frame = useCurrentFrame();
const { fps } = useVideoConfig();
+
const pages = useMemo(
() =>
createTikTokStyleCaptions({
@@ -27,7 +28,9 @@ const AccentCaptionsInner = ({
}).pages,
[captions, combineTokensWithinMilliseconds],
);
+
const currentTimeMs = (frame / fps) * 1000;
+
const page = pages.find(
(candidate) =>
currentTimeMs >= candidate.startMs &&
@@ -62,8 +65,10 @@ const AccentCaptionsInner = ({
{page?.tokens.map((token, index) => {
const active =
currentTimeMs >= token.fromMs && currentTimeMs < token.toMs;
+
const text = token.text.trim();
const start = token.text.indexOf(text);
+
return (
<Fragment key={`${page.startMs}-${index}`}>
{token.text.slice(0, start)}
diff --git a/packages/template-element-library/lib/element-payload.ts b/packages/template-element-library/lib/element-payload.ts
index 1a8f0094b8..ecf4dbe4e7 100644
--- a/packages/template-element-library/lib/element-payload.ts
+++ b/packages/template-element-library/lib/element-payload.ts
@@ -10,6 +10,7 @@ const sources = import.meta.glob<string>("../elements/*/*.tsx", {
export const catalog = elements.map((definition) => {
const sourceCode =
sources[`../elements/${definition.slug}/${definition.slug}.tsx`];
+
if (!sourceCode) {
throw new Error(`Missing source for Element: ${definition.slug}`);
}
diff --git a/packages/template-element-library/remotion.config.ts b/packages/template-element-library/remotion.config.ts
index 92a48b061a..eab91e7439 100644
--- a/packages/template-element-library/remotion.config.ts
+++ b/packages/template-element-library/remotion.config.ts
@@ -1,4 +1,5 @@
import { Config } from "@remotion/cli/config";
Config.setRspack(true);
+
Config.setEntryPoint("remotion/index.ts");
diff --git a/packages/template-element-library/remotion/ElementPreview.tsx b/packages/template-element-library/remotion/ElementPreview.tsx
index b4dbfb82ea..88ed0d2c52 100644
--- a/packages/template-element-library/remotion/ElementPreview.tsx
+++ b/packages/template-element-library/remotion/ElementPreview.tsx
@@ -4,21 +4,24 @@ import { AnimatedTitle } from "../elements/animated-title/animated-title";
import { LowerThird } from "../elements/lower-third/lower-third";
import { AnimatedBackground } from "../elements/animated-background/animated-background";
import { AccentCaptions } from "../elements/accent-captions/accent-captions";
-import type { ComponentType } from "react";
-const components: Record<string, ComponentType<Record<string, unknown>>> = {
- "animated-title": AnimatedTitle,
- "lower-third": LowerThird,
- "animated-background": AnimatedBackground,
- "accent-captions": AccentCaptions,
-};
+const components = new Map(
+ Object.entries({
+ "animated-title": AnimatedTitle,
+ "lower-third": LowerThird,
+ "animated-background": AnimatedBackground,
+ "accent-captions": AccentCaptions,
+ }),
+);
export const ElementPreview = ({ slug }: { slug: string }) => {
const definition = elements.find((element) => element.slug === slug);
- const Component = components[slug];
+ const Component = components.get(slug);
+
if (!definition || !Component) {
throw new Error(`Unknown Element: ${slug}`);
}
+
const dimensions = definition.dimensions;
return (
diff --git a/packages/template-element-library/scripts/render-previews.ts b/packages/template-element-library/scripts/render-previews.ts
index a4d422a559..78f9bb5bbd 100644
--- a/packages/template-element-library/scripts/render-previews.ts
+++ b/packages/template-element-library/scripts/render-previews.ts
@@ -13,6 +13,7 @@ const { values } = parseArgs({
help: { type: "boolean", short: "h" },
},
});
+
if (values.help) {
console.log(
"Usage: npm run render-previews -- [--element=<slug>] [--browser-executable=<path>]",
@@ -24,8 +25,10 @@ const selected =
values.element === undefined
? elements
: elements.filter(({ slug }) => slug === values.element);
+
if (selected.length === 0)
throw new Error(`Unknown Element: ${values.element}`);
+
for (const { slug } of selected) {
if (!/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(slug)) {
throw new Error(`Invalid Element slug: ${slug}`);
@@ -33,21 +36,27 @@ for (const { slug } of selected) {
}
const manifestPath = path.resolve("elements/previews.json");
+
const previews: Record<string, { posterUrl: string; videoUrl: string }> =
JSON.parse(await readFile(manifestPath, "utf8"));
+
const browserExecutable = values["browser-executable"] ?? null;
+
const serveUrl = await bundle({
entryPoint: path.resolve("remotion/previews.tsx"),
});
+
const compositions = await getCompositions({
serveUrl,
inputProps: {},
browserExecutable,
});
+
const version = randomUUID();
for (const definition of selected) {
const composition = compositions.find(({ id }) => id === definition.slug);
+
if (!composition)
throw new Error(`Missing preview composition: ${definition.slug}`);
const transparent = definition.previewBackground === "transparent";
@@ -79,8 +88,11 @@ for (const definition of selected) {
}
const temporaryManifest = `${manifestPath}.${version}.tmp`;
+
await writeFile(temporaryManifest, `${JSON.stringify(previews, null, 2)}\n`);
+
await rename(temporaryManifest, manifestPath);
+
console.log(
"Previews rendered. Review them on the website before running upload-previews.",
);
diff --git a/packages/template-element-library/scripts/upload-previews.ts b/packages/template-element-library/scripts/upload-previews.ts
index e40859508e..593c2dd109 100644
--- a/packages/template-element-library/scripts/upload-previews.ts
+++ b/packages/template-element-library/scripts/upload-previews.ts
@@ -11,6 +11,7 @@ const { values } = parseArgs({
help: { type: "boolean", short: "h" },
},
});
+
if (values.help) {
console.log(
"Usage: npm run upload-previews -- [--element=<slug>]\nConfigure .env using .env.example. Render and review previews first.",
@@ -22,6 +23,7 @@ const selected =
values.element === undefined
? elements
: elements.filter(({ slug }) => slug === values.element);
+
if (selected.length === 0)
throw new Error(`Unknown Element: ${values.element}`);
@@ -32,6 +34,7 @@ const {
AWS_ACCESS_KEY_ID,
AWS_SECRET_ACCESS_KEY,
} = process.env;
+
if (
!S3_ENDPOINT ||
!S3_BUCKET ||
@@ -43,7 +46,9 @@ if (
"Missing upload configuration. Copy .env.example to .env and configure your bucket, public URL, and credentials.",
);
}
+
const publicBase = new URL(`${S3_PUBLIC_URL.replace(/\/$/, "")}/`);
+
if (
publicBase.protocol !== "https:" ||
publicBase.username ||
@@ -55,16 +60,22 @@ if (
"S3_PUBLIC_URL must be a public HTTPS URL without credentials, a query, or a fragment.",
);
}
+
const prefix = process.env.S3_PREFIX ?? "element-previews";
+
if (!/^[a-zA-Z0-9_-]+(?:\/[a-zA-Z0-9_-]+)*$/.test(prefix)) {
throw new Error(
"S3_PREFIX must contain slash-separated letters, numbers, underscores, or hyphens.",
);
}
+
const manifestPath = path.resolve("elements/previews.json");
+
const previews: Record<string, { posterUrl: string; videoUrl: string }> =
JSON.parse(await readFile(manifestPath, "utf8"));
+
const version = randomUUID();
+
const uploads: {
slug: string;
field: "posterUrl" | "videoUrl";
@@ -76,28 +87,36 @@ const uploads: {
for (const definition of selected) {
const { slug } = definition;
+
if (!/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(slug))
throw new Error(`Invalid Element slug: ${slug}`);
const preview = previews[slug];
+
if (!preview) throw new Error(`Run render-previews for ${slug} first.`);
let size = 0;
+
for (const field of ["posterUrl", "videoUrl"] as const) {
const url = preview[field];
+
const extension =
field === "posterUrl"
? "png"
: definition.previewBackground === "transparent"
? "webm"
: "mp4";
+
const pattern = new RegExp(
`^/previews/${slug}/[a-f0-9-]+/preview\\.${extension}$`,
);
+
if (typeof url !== "string" || !pattern.test(url)) {
throw new Error(
`Render and review local previews for ${slug} before uploading. Hosted previews are not downloaded or overwritten.`,
);
}
+
const bytes = await readFile(path.join("public", url));
+
const valid =
extension === "png"
? bytes
@@ -106,6 +125,7 @@ for (const definition of selected) {
: extension === "webm"
? bytes.subarray(0, 4).equals(Buffer.from([26, 69, 223, 163]))
: bytes.subarray(4, 8).toString() === "ftyp";
+
if (!valid) throw new Error(`Invalid ${extension} preview: ${url}`);
size += bytes.length;
const key = `${prefix}/${slug}/${version}/preview.${extension}`;
@@ -118,6 +138,7 @@ for (const definition of selected) {
publicUrl: new URL(key, publicBase).href,
});
}
+
if (size > 10 * 1024 * 1024)
throw new Error(`Previews for ${slug} exceed 10 MiB.`);
}
@@ -130,6 +151,7 @@ const client = new S3Client({
secretAccessKey: AWS_SECRET_ACCESS_KEY,
},
});
+
try {
for (const asset of uploads) {
await client.send(
@@ -142,9 +164,11 @@ try {
IfNoneMatch: "*",
}),
);
+
const response = await fetch(asset.publicUrl, {
signal: AbortSignal.timeout(30_000),
});
+
if (
!response.ok ||
response.headers.get("content-type")?.split(";")[0] !== asset.contentType
@@ -153,7 +177,9 @@ try {
`Public preview verification failed: ${asset.publicUrl} (${response.status}). The manifest has not been changed.`,
);
}
+
const remote = Buffer.from(await response.arrayBuffer());
+
if (
createHash("sha256").update(remote).digest("hex") !==
createHash("sha256").update(asset.bytes).digest("hex")
@@ -162,9 +188,11 @@ try {
`Uploaded preview checksum mismatch: ${asset.publicUrl}. The manifest has not been changed.`,
);
}
+
previews[asset.slug][asset.field] = asset.publicUrl;
console.log(`Verified ${asset.publicUrl}`);
}
+
const temporaryManifest = `${manifestPath}.${version}.tmp`;
await writeFile(temporaryManifest, `${JSON.stringify(previews, null, 2)}\n`);
await rename(temporaryManifest, manifestPath);