Skip to content

🎥 Make videos programmatically with React

Elements: Add Shine effect (#11288)

Igor Samokhovetsc4ff31da35b2
diff --git a/packages/docs/elements/commerce/index.mdx b/packages/docs/elements/commerce/index.mdx
index 63649f07b6..07c50e8b3b 100644
--- a/packages/docs/elements/commerce/index.mdx
+++ b/packages/docs/elements/commerce/index.mdx
@@ -1,10 +1,10 @@
---
-title: Commerce
-description: Animated commerce Elements for Remotion videos.
+title: Effects
+description: Animated visual effects for Remotion videos.
---
import {ElementLibrary} from '@site/src/components/Elements/ElementLibrary';
-# Commerce
+# Effects
<ElementLibrary category="commerce" />
diff --git a/packages/docs/elements/commerce/shine/index.mdx b/packages/docs/elements/commerce/shine/index.mdx
new file mode 100644
index 0000000000..b7628301b9
--- /dev/null
+++ b/packages/docs/elements/commerce/shine/index.mdx
@@ -0,0 +1,12 @@
+---
+title: Shine
+description: Adds a diagonal shine sweep to any content.
+image: https://remotion.media/elements/commerce-shine-preview.png
+---
+
+import {ElementPage} from '@site/src/components/Elements/ElementPage';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
+
+# Shine
+
+<ElementPage definition={getElementDefinition('commerce/shine')} sourceFile="./shine.tsx" />
diff --git a/packages/docs/elements/commerce/shine/shine.tsx b/packages/docs/elements/commerce/shine/shine.tsx
new file mode 100644
index 0000000000..88dc7ad3a0
--- /dev/null
+++ b/packages/docs/elements/commerce/shine/shine.tsx
@@ -0,0 +1,43 @@
+import {scale} from '@remotion/effects/scale';
+import {shine} from '@remotion/effects/shine';
+import React from 'react';
+import {
+ CanvasImage,
+ HtmlInCanvas,
+ interpolate,
+ useCurrentFrame,
+} from 'remotion';
+
+export const Shine: React.FC = () => {
+ const frame = useCurrentFrame();
+
+ return (
+ <HtmlInCanvas
+ effects={[
+ scale({scale: 0.75}),
+ shine({
+ progress: interpolate(frame, [0, 44], [0, 1], {
+ extrapolateLeft: 'clamp',
+ extrapolateRight: 'clamp',
+ }),
+ angle: 30,
+ haloSigma: 200,
+ coreSigma: 65,
+ haloIntensity: 0.3,
+ coreIntensity: 0.4,
+ }),
+ ]}
+ height={720}
+ name="Shine"
+ width={1280}
+ >
+ <CanvasImage
+ fit="cover"
+ height={720}
+ name="A graphic"
+ src="https://remotion.media/elements/commerce-tear-a-graphic.png"
+ width={1280}
+ />
+ </HtmlInCanvas>
+ );
+};
diff --git a/packages/docs/src/components/Elements/ElementPage.tsx b/packages/docs/src/components/Elements/ElementPage.tsx
index ff1336bc64..57a3322732 100644
--- a/packages/docs/src/components/Elements/ElementPage.tsx
+++ b/packages/docs/src/components/Elements/ElementPage.tsx
@@ -197,6 +197,11 @@ export const ElementPage: React.FC<ElementPageProps> = ({
elementHeight={definition.elementHeight}
elementWidth={definition.elementWidth}
fps={fps}
+ htmlInCanvasFallbackVideoUrl={
+ definition.previewUsesHtmlInCanvas
+ ? definition.preview.videoUrl
+ : null
+ }
previewLayout={definition.preview.previewLayout}
safeArea={definition.safeArea}
/>
diff --git a/packages/docs/src/components/Elements/ElementPreview.tsx b/packages/docs/src/components/Elements/ElementPreview.tsx
index 3d0bdcd844..073706c579 100644
--- a/packages/docs/src/components/Elements/ElementPreview.tsx
+++ b/packages/docs/src/components/Elements/ElementPreview.tsx
@@ -1,5 +1,8 @@
+import {Video} from '@remotion/media';
import {Player} from '@remotion/player';
-import React, {useState, type ComponentType} from 'react';
+import React, {useMemo, useState, type ComponentType} from 'react';
+import {AbsoluteFill} from 'remotion';
+import {useHtmlInCanvasDocsDemoBranch} from '../../../components/demos/useHtmlInCanvasDocsDemoBranch';
import type {ElementPreviewLayout} from './element-definitions';
type ElementPreviewProps = {
@@ -8,6 +11,7 @@ type ElementPreviewProps = {
readonly elementHeight: number | null;
readonly elementWidth: number | null;
readonly fps: number;
+ readonly htmlInCanvasFallbackVideoUrl: string | null;
readonly previewLayout: ElementPreviewLayout;
readonly safeArea: number;
};
@@ -18,16 +22,55 @@ const lightPreviewBackground = '#f5f6f7';
const checkerboardBackground =
'conic-gradient(rgba(0, 0, 0, 0.1) 25%, transparent 0 50%, rgba(0, 0, 0, 0.1) 0 75%, transparent 0)';
+const HtmlInCanvasElementPreview: React.FC<{
+ readonly component: ComponentType<Record<string, never>>;
+ readonly fallbackVideoUrl: string;
+}> = ({component: Component, fallbackVideoUrl}) => {
+ const branch = useHtmlInCanvasDocsDemoBranch('webgl2');
+
+ if (branch === 'pending') {
+ return <AbsoluteFill />;
+ }
+
+ if (branch === 'fallback') {
+ return (
+ <AbsoluteFill>
+ <Video
+ muted
+ objectFit="contain"
+ src={fallbackVideoUrl}
+ style={{height: '100%', width: '100%'}}
+ />
+ </AbsoluteFill>
+ );
+ }
+
+ return <Component />;
+};
+
export const ElementPreview: React.FC<ElementPreviewProps> = ({
component,
durationInFrames,
elementHeight,
elementWidth,
fps,
+ htmlInCanvasFallbackVideoUrl,
previewLayout,
safeArea,
}) => {
const [checkerboard, setCheckerboard] = useState(true);
+ const playerComponent = useMemo(() => {
+ if (htmlInCanvasFallbackVideoUrl === null) {
+ return component;
+ }
+
+ return () => (
+ <HtmlInCanvasElementPreview
+ component={component}
+ fallbackVideoUrl={htmlInCanvasFallbackVideoUrl}
+ />
+ );
+ }, [component, htmlInCanvasFallbackVideoUrl]);
const transparencyBackgroundStyle: React.CSSProperties = checkerboard
? {
backgroundColor: 'white',
@@ -92,7 +135,7 @@ export const ElementPreview: React.FC<ElementPreviewProps> = ({
<Player
acknowledgeRemotionLicense
autoPlay
- component={component}
+ component={playerComponent}
durationInFrames={durationInFrames}
fps={fps}
compositionWidth={previewWidth}
diff --git a/packages/docs/src/components/Elements/element-definitions.ts b/packages/docs/src/components/Elements/element-definitions.ts
index 370377118b..70586a06d4 100644
--- a/packages/docs/src/components/Elements/element-definitions.ts
+++ b/packages/docs/src/components/Elements/element-definitions.ts
@@ -27,6 +27,7 @@ import {
} from '../../../elements/commerce/product-collection/product-collection';
import {ProductDiscountCallout} from '../../../elements/commerce/product-discount-callout/product-discount-callout';
import {ProductOffer} from '../../../elements/commerce/product-offer/product-offer';
+import {Shine} from '../../../elements/commerce/shine/shine';
import {HorizontalBarChart} from '../../../elements/data/horizontal-bar-chart/horizontal-bar-chart';
import {LineChart} from '../../../elements/data/line-chart/line-chart';
import {NumberCounter} from '../../../elements/data/number-counter/number-counter';
@@ -84,6 +85,7 @@ export type ElementDefinition = {
readonly initialProps: ElementInitialProps | null;
readonly posterFrame: number;
readonly preview: ElementPreviewMetadata;
+ readonly previewUsesHtmlInCanvas: boolean;
readonly safeArea: number;
readonly slug: string;
readonly installationMode: ElementInstallationMode;
@@ -505,6 +507,28 @@ const elementImplementations = [
installationMode: 'wrapped',
width: 1080,
},
+ {
+ slug: 'commerce/shine',
+ component: Shine,
+ contributors: [],
+ description: 'Adds a diagonal shine sweep to any content.',
+ dependencies: [{name: '@remotion/effects', version: null}],
+ durationInFrames: 45,
+ elementHeight: 720,
+ elementWidth: 1280,
+ fps: 30,
+ height: 1080,
+ posterFrame: 22,
+ preview: {
+ previewLayout: 'composition',
+ posterUrl: 'https://remotion.media/elements/commerce-shine-preview.png',
+ videoUrl: 'https://remotion.media/elements/commerce-shine-preview.mp4',
+ },
+ safeArea: 0,
+ initialProps: null,
+ installationMode: 'wrapped',
+ width: 1920,
+ },
{
slug: 'data/horizontal-bar-chart',
component: HorizontalBarChart,
@@ -1044,12 +1068,15 @@ const elementImplementations = [
},
] satisfies readonly (Omit<
ElementDefinition,
- 'category' | 'displayName' | 'slug'
+ 'category' | 'displayName' | 'previewUsesHtmlInCanvas' | 'slug'
> & {
readonly slug: ElementSlug;
})[];
+const htmlInCanvasElementSlugs = new Set<ElementSlug>(['commerce/shine']);
+
export const elementDefinitions = elementImplementations.map((definition) => ({
...elementRegistry[definition.slug],
...definition,
+ previewUsesHtmlInCanvas: htmlInCanvasElementSlugs.has(definition.slug),
}));
diff --git a/packages/docs/src/components/Elements/element-registry.ts b/packages/docs/src/components/Elements/element-registry.ts
index 573998ce0b..666d834ddd 100644
--- a/packages/docs/src/components/Elements/element-registry.ts
+++ b/packages/docs/src/components/Elements/element-registry.ts
@@ -3,7 +3,7 @@ export const elementCategories = [
{category: 'backgrounds', label: 'Backgrounds'},
{category: 'captions', label: 'Captions'},
{category: 'data', label: 'Charts & Data'},
- {category: 'commerce', label: 'Commerce'},
+ {category: 'commerce', label: 'Effects'},
{category: 'maps', label: 'Maps'},
{category: 'overlays', label: 'Overlays'},
{category: 'storytelling', label: 'Storytelling'},
@@ -78,6 +78,10 @@ export const elementRegistry = {
category: 'commerce',
displayName: 'Product Offer',
},
+ 'commerce/shine': {
+ category: 'commerce',
+ displayName: 'Shine',
+ },
'data/horizontal-bar-chart': {
category: 'data',
displayName: 'Horizontal Bar Chart',