Skip to content

🎥 Make videos programmatically with React

Elements: Unify preview backgrounds under backgroundTheme

Igor Samokhovetsf0cbc954627c
diff --git a/packages/docs/src/components/Elements/ElementPage.tsx b/packages/docs/src/components/Elements/ElementPage.tsx
index 96ae3c5270..fab0ac702a 100644
--- a/packages/docs/src/components/Elements/ElementPage.tsx
+++ b/packages/docs/src/components/Elements/ElementPage.tsx
@@ -193,8 +193,7 @@ export const ElementPage: React.FC<ElementPageProps> = ({
<section aria-label="Preview" className={styles.previewColumn}>
<div className={styles.previewAndSource}>
<ElementPreview
- backgroundColor={definition.preview.backgroundColor ?? null}
- checkerboardTheme={definition.preview.checkerboardTheme}
+ backgroundTheme={definition.preview.backgroundTheme}
component={PreviewComponent}
durationInFrames={durationInFrames}
elementHeight={definition.elementHeight}
diff --git a/packages/docs/src/components/Elements/ElementPreview.tsx b/packages/docs/src/components/Elements/ElementPreview.tsx
index c473689afe..f3c2a4ef59 100644
--- a/packages/docs/src/components/Elements/ElementPreview.tsx
+++ b/packages/docs/src/components/Elements/ElementPreview.tsx
@@ -4,13 +4,13 @@ import React, {useMemo, useState, type ComponentType} from 'react';
import {AbsoluteFill} from 'remotion';
import {useHtmlInCanvasDocsDemoBranch} from '../../../components/demos/useHtmlInCanvasDocsDemoBranch';
import type {
- ElementCheckerboardTheme,
+ ElementBackgroundTheme,
ElementPreviewLayout,
} from './element-definitions';
+import {ELEMENT_PREVIEW_DARK_BACKGROUND} from './ElementPreviewComposition';
type ElementPreviewProps = {
- readonly backgroundColor: string | null;
- readonly checkerboardTheme: ElementCheckerboardTheme;
+ readonly backgroundTheme: ElementBackgroundTheme;
readonly component: ComponentType<Record<string, never>>;
readonly durationInFrames: number;
readonly elementHeight: number | null;
@@ -24,7 +24,6 @@ type ElementPreviewProps = {
const previewHeight = 1080;
const previewWidth = 1920;
const lightPreviewBackground = '#f5f6f7';
-const darkPreviewBackground = '#202124';
const checkerboardBackgrounds = {
light:
'conic-gradient(rgba(0, 0, 0, 0.1) 25%, transparent 0 50%, rgba(0, 0, 0, 0.1) 0 75%, transparent 0)',
@@ -58,8 +57,7 @@ const HtmlInCanvasElementPreview: React.FC<{
};
export const ElementPreview: React.FC<ElementPreviewProps> = ({
- backgroundColor,
- checkerboardTheme,
+ backgroundTheme,
component,
durationInFrames,
elementHeight,
@@ -83,16 +81,16 @@ export const ElementPreview: React.FC<ElementPreviewProps> = ({
);
}, [component, htmlInCanvasFallbackVideoUrl]);
const previewBackgroundColor =
- backgroundColor ??
- (checkerboardTheme === 'dark'
- ? darkPreviewBackground
- : lightPreviewBackground);
+ backgroundTheme === 'dark'
+ ? ELEMENT_PREVIEW_DARK_BACKGROUND
+ : lightPreviewBackground;
const transparencyBackgroundStyle: React.CSSProperties = checkerboard
? {
backgroundColor:
- backgroundColor ??
- (checkerboardTheme === 'dark' ? darkPreviewBackground : 'white'),
- backgroundImage: checkerboardBackgrounds[checkerboardTheme],
+ backgroundTheme === 'dark'
+ ? ELEMENT_PREVIEW_DARK_BACKGROUND
+ : 'white',
+ backgroundImage: checkerboardBackgrounds[backgroundTheme],
backgroundSize: '32px 32px',
}
: {backgroundColor: previewBackgroundColor};
@@ -129,7 +127,7 @@ export const ElementPreview: React.FC<ElementPreviewProps> = ({
}
const transparencyLabel = checkerboard
- ? `Use ${checkerboardTheme} preview background`
+ ? `Use ${backgroundTheme} preview background`
: 'Show transparency as checkerboard';
return (
diff --git a/packages/docs/src/components/Elements/ElementPreviewComposition.tsx b/packages/docs/src/components/Elements/ElementPreviewComposition.tsx
index 6da570c995..7e8f60e701 100644
--- a/packages/docs/src/components/Elements/ElementPreviewComposition.tsx
+++ b/packages/docs/src/components/Elements/ElementPreviewComposition.tsx
@@ -4,6 +4,7 @@ import type {ElementDefinition} from './element-definitions';
import {getElementDefinition} from './element-utils';
export const ELEMENT_PREVIEW_BACKGROUND = '#eef1f4';
+export const ELEMENT_PREVIEW_DARK_BACKGROUND = '#20262f';
export const getElementPreviewDimensions = (definition: ElementDefinition) => {
const hasElementDimensions =
@@ -99,7 +100,9 @@ export const ElementAssetComposition: React.FC<{
<AbsoluteFill
style={{
backgroundColor:
- definition.preview.backgroundColor ?? ELEMENT_PREVIEW_BACKGROUND,
+ definition.preview.backgroundTheme === 'dark'
+ ? ELEMENT_PREVIEW_DARK_BACKGROUND
+ : ELEMENT_PREVIEW_BACKGROUND,
}}
showInTimeline={false}
>
diff --git a/packages/docs/src/components/Elements/element-definitions.ts b/packages/docs/src/components/Elements/element-definitions.ts
index 9ba57912ed..839bd4244a 100644
--- a/packages/docs/src/components/Elements/element-definitions.ts
+++ b/packages/docs/src/components/Elements/element-definitions.ts
@@ -71,11 +71,10 @@ import {
export type ElementPreviewLayout = 'composition' | 'vertical';
-export type ElementCheckerboardTheme = 'light' | 'dark';
+export type ElementBackgroundTheme = 'light' | 'dark';
export type ElementPreviewMetadata = {
- readonly backgroundColor?: string;
- readonly checkerboardTheme: ElementCheckerboardTheme;
+ readonly backgroundTheme: ElementBackgroundTheme;
readonly previewLayout: ElementPreviewLayout;
readonly posterUrl:
| `/elements/${string}-preview.png`
@@ -155,7 +154,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/audio-oscilloscope-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/audio-oscilloscope-preview.mp4',
},
@@ -187,7 +186,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/audio-waveform-progress-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/audio-waveform-progress-preview.mp4',
},
@@ -219,7 +218,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/audio-mirrored-spectrum-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/audio-mirrored-spectrum-preview.mp4',
},
@@ -246,7 +245,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-notebook-paper-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-notebook-paper-preview.mp4',
},
@@ -274,7 +273,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-paper-texture-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-paper-texture-preview.mp4',
},
@@ -301,7 +300,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-rotating-starburst-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-rotating-starburst-preview.mp4',
},
@@ -328,7 +327,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-moving-waves-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-moving-waves-preview.mp4',
},
@@ -355,7 +354,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-moving-zigzags-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-moving-zigzags-preview.mp4',
},
@@ -383,7 +382,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/backgrounds-liquid-contours-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/backgrounds-liquid-contours-preview.mp4',
},
@@ -411,7 +410,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/captions-basic-captions-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/captions-basic-captions-preview.mp4',
},
@@ -444,7 +443,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/captions-rounded-captions-preview-694426c4-721c-484f-8a33-79f21d54da5d.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/captions-rounded-captions-preview-694426c4-721c-484f-8a33-79f21d54da5d.mp4',
},
@@ -476,7 +475,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/captions-moving-pill-captions-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/captions-moving-pill-captions-preview.mp4',
},
@@ -507,7 +506,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/captions-popping-word-captions-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/captions-popping-word-captions-preview.mp4',
},
@@ -538,7 +537,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/captions-word-highlight-captions-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/captions-word-highlight-captions-preview.mp4',
},
@@ -565,7 +564,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/commerce-product-collection-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/commerce-product-collection-preview.mp4',
},
@@ -595,7 +594,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/commerce-product-discount-callout-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/commerce-product-discount-callout-preview.mp4',
},
@@ -621,7 +620,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/commerce-shine-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/commerce-shine-preview.mp4',
},
safeArea: 0,
@@ -646,7 +645,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/commerce-tear-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/commerce-tear-preview.mp4',
},
safeArea: 0,
@@ -672,7 +671,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/data-horizontal-bar-chart-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/data-horizontal-bar-chart-preview.mp4',
},
@@ -698,7 +697,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/data-line-chart-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/data-line-chart-preview.mp4',
},
safeArea: 0,
@@ -730,7 +729,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/data-number-counter-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/data-number-counter-preview.mp4',
},
@@ -757,7 +756,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/data-pie-chart-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/data-pie-chart-preview.mp4',
},
safeArea: 0,
@@ -784,7 +783,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/data-vertical-bar-chart-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/data-vertical-bar-chart-preview.mp4',
},
@@ -812,7 +811,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/layouts-picture-in-picture-transition-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/layouts-picture-in-picture-transition-preview.mp4',
},
@@ -840,7 +839,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/layouts-slide-to-split-screen-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/layouts-slide-to-split-screen-preview.mp4',
},
@@ -870,7 +869,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/maps-map-flyover-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/maps-map-flyover-preview.mp4',
},
safeArea: 0,
@@ -900,7 +899,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/maps-watercolor-map-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/maps-watercolor-map-preview.mp4',
},
@@ -927,7 +926,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/overlays-location-lower-third-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/overlays-location-lower-third-preview.mp4',
},
@@ -955,7 +954,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/overlays-name-lower-third-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/overlays-name-lower-third-preview.mp4',
},
@@ -983,7 +982,7 @@ const elementImplementations = [
previewLayout: 'vertical',
posterUrl:
'https://remotion.media/elements/overlays-social-safe-zones-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/overlays-social-safe-zones-preview.mp4',
},
@@ -1010,7 +1009,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/text-news-article-highlight-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/text-news-article-highlight-preview.mp4',
},
@@ -1034,8 +1033,7 @@ const elementImplementations = [
height: 1080,
posterFrame: 15,
preview: {
- backgroundColor: '#20262f',
- checkerboardTheme: 'dark',
+ backgroundTheme: 'dark',
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/storytelling-speed-lines-preview-589e0765-d9d0-4d46-bcff-86e7bcf79c05.png',
@@ -1066,7 +1064,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/storytelling-on-screen-messages-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/storytelling-on-screen-messages-preview.mp4',
},
@@ -1094,7 +1092,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/storytelling-polaroid-pictures-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/storytelling-polaroid-pictures-preview.mp4',
},
@@ -1125,7 +1123,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/text-circle-marker-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/text-circle-marker-preview.mp4',
},
@@ -1155,7 +1153,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/text-crossed-off-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/text-crossed-off-preview.mp4',
},
safeArea: 120,
@@ -1182,7 +1180,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/text-spinning-text-wheel-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/text-spinning-text-wheel-preview.mp4',
},
@@ -1213,7 +1211,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/text-strike-through-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/text-strike-through-preview.mp4',
},
@@ -1243,7 +1241,7 @@ const elementImplementations = [
preview: {
previewLayout: 'composition',
posterUrl: 'https://remotion.media/elements/text-text-marker-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl: 'https://remotion.media/elements/text-text-marker-preview.mp4',
},
safeArea: 120,
@@ -1269,7 +1267,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/youtube-youtube-comment-highlight-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/youtube-youtube-comment-highlight-preview.mp4',
},
@@ -1297,7 +1295,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/overlays-social-endcard-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/overlays-social-endcard-preview.mp4',
},
@@ -1337,7 +1335,7 @@ const elementImplementations = [
previewLayout: 'composition',
posterUrl:
'https://remotion.media/elements/youtube-youtube-subscribe-nudge-preview.png',
- checkerboardTheme: 'light',
+ backgroundTheme: 'light',
videoUrl:
'https://remotion.media/elements/youtube-youtube-subscribe-nudge-preview.mp4',
},