Skip to content

🎥 Make videos programmatically with React

Elements: Fix array lookups in MDX pages

JonnyBurgere9803325a679
diff --git a/packages/docs/elements-sidebars.ts b/packages/docs/elements-sidebars.ts
index 03e710ba6c..386a0e6e10 100644
--- a/packages/docs/elements-sidebars.ts
+++ b/packages/docs/elements-sidebars.ts
@@ -5,6 +5,7 @@ import {
elementRegistry,
} from './src/components/Elements/element-registry';
+// Keep navigation alphabetical; the library uses the curated definitions array order.
const compareStrings = (a: string, b: string) => {
if (a < b) {
return -1;
diff --git a/packages/docs/elements/audio/mirrored-spectrum/index.mdx b/packages/docs/elements/audio/mirrored-spectrum/index.mdx
index 5bf7d92bc6..c85053a920 100644
--- a/packages/docs/elements/audio/mirrored-spectrum/index.mdx
+++ b/packages/docs/elements/audio/mirrored-spectrum/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/audio-mirrored-spectrum-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Mirrored Audio Spectrum
-<ElementPage definition={elementDefinitions['audio/mirrored-spectrum']} sourceFile="./mirrored-spectrum.tsx" />
+<ElementPage definition={getElementDefinition('audio/mirrored-spectrum')} sourceFile="./mirrored-spectrum.tsx" />
diff --git a/packages/docs/elements/audio/oscilloscope/index.mdx b/packages/docs/elements/audio/oscilloscope/index.mdx
index 7c8a7248df..b398beec83 100644
--- a/packages/docs/elements/audio/oscilloscope/index.mdx
+++ b/packages/docs/elements/audio/oscilloscope/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/audio-oscilloscope-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Audio Oscilloscope
-<ElementPage definition={elementDefinitions['audio/oscilloscope']} sourceFile="./audio-oscilloscope.tsx" />
+<ElementPage definition={getElementDefinition('audio/oscilloscope')} sourceFile="./audio-oscilloscope.tsx" />
diff --git a/packages/docs/elements/audio/waveform-progress/index.mdx b/packages/docs/elements/audio/waveform-progress/index.mdx
index 473e1c6d93..4759b36d0f 100644
--- a/packages/docs/elements/audio/waveform-progress/index.mdx
+++ b/packages/docs/elements/audio/waveform-progress/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/audio-waveform-progress-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Audio Waveform Progress
-<ElementPage definition={elementDefinitions['audio/waveform-progress']} sourceFile="./audio-waveform-progress.tsx" />
+<ElementPage definition={getElementDefinition('audio/waveform-progress')} sourceFile="./audio-waveform-progress.tsx" />
diff --git a/packages/docs/elements/backgrounds/liquid-contours/index.mdx b/packages/docs/elements/backgrounds/liquid-contours/index.mdx
index a502ad2cfa..49411b6f84 100644
--- a/packages/docs/elements/backgrounds/liquid-contours/index.mdx
+++ b/packages/docs/elements/backgrounds/liquid-contours/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/backgrounds-liquid-contours-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Liquid Contours
-<ElementPage definition={elementDefinitions['backgrounds/liquid-contours']} sourceFile="./liquid-contours.tsx" />
+<ElementPage definition={getElementDefinition('backgrounds/liquid-contours')} sourceFile="./liquid-contours.tsx" />
diff --git a/packages/docs/elements/backgrounds/notebook-paper/index.mdx b/packages/docs/elements/backgrounds/notebook-paper/index.mdx
index ab9a2f95d5..378522d4a1 100644
--- a/packages/docs/elements/backgrounds/notebook-paper/index.mdx
+++ b/packages/docs/elements/backgrounds/notebook-paper/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/backgrounds-notebook-paper-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Notebook Paper
-<ElementPage definition={elementDefinitions['backgrounds/notebook-paper']} sourceFile="./notebook-paper.tsx" />
+<ElementPage definition={getElementDefinition('backgrounds/notebook-paper')} sourceFile="./notebook-paper.tsx" />
diff --git a/packages/docs/elements/backgrounds/paper-texture/index.mdx b/packages/docs/elements/backgrounds/paper-texture/index.mdx
index b6f4624eee..6dffc2f276 100644
--- a/packages/docs/elements/backgrounds/paper-texture/index.mdx
+++ b/packages/docs/elements/backgrounds/paper-texture/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/backgrounds-paper-texture-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Paper Texture
-<ElementPage definition={elementDefinitions['backgrounds/paper-texture']} sourceFile="./paper-texture.tsx" />
+<ElementPage definition={getElementDefinition('backgrounds/paper-texture')} sourceFile="./paper-texture.tsx" />
diff --git a/packages/docs/elements/backgrounds/rotating-starburst/index.mdx b/packages/docs/elements/backgrounds/rotating-starburst/index.mdx
index 084588ded5..267a06e107 100644
--- a/packages/docs/elements/backgrounds/rotating-starburst/index.mdx
+++ b/packages/docs/elements/backgrounds/rotating-starburst/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/backgrounds-rotating-starburst-preview.pn
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Rotating Starburst
-<ElementPage definition={elementDefinitions['backgrounds/rotating-starburst']} sourceFile="./rotating-starburst.tsx" />
+<ElementPage definition={getElementDefinition('backgrounds/rotating-starburst')} sourceFile="./rotating-starburst.tsx" />
diff --git a/packages/docs/elements/captions/basic-captions/index.mdx b/packages/docs/elements/captions/basic-captions/index.mdx
index 60cc5b632e..0652204bd9 100644
--- a/packages/docs/elements/captions/basic-captions/index.mdx
+++ b/packages/docs/elements/captions/basic-captions/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/captions-basic-captions-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Basic Captions
-<ElementPage definition={elementDefinitions['captions/basic-captions']} sourceFile="./basic-captions.tsx" />
+<ElementPage definition={getElementDefinition('captions/basic-captions')} sourceFile="./basic-captions.tsx" />
diff --git a/packages/docs/elements/captions/moving-pill-captions/index.mdx b/packages/docs/elements/captions/moving-pill-captions/index.mdx
index 34314ce40d..d31bc92c2c 100644
--- a/packages/docs/elements/captions/moving-pill-captions/index.mdx
+++ b/packages/docs/elements/captions/moving-pill-captions/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/captions-moving-pill-captions-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Moving Pill Captions
-<ElementPage definition={elementDefinitions['captions/moving-pill-captions']} sourceFile="./moving-pill-captions.tsx" />
+<ElementPage definition={getElementDefinition('captions/moving-pill-captions')} sourceFile="./moving-pill-captions.tsx" />
diff --git a/packages/docs/elements/captions/popping-word-captions/index.mdx b/packages/docs/elements/captions/popping-word-captions/index.mdx
index adf903a2c2..d78d99954a 100644
--- a/packages/docs/elements/captions/popping-word-captions/index.mdx
+++ b/packages/docs/elements/captions/popping-word-captions/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/captions-popping-word-captions-preview.pn
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Popping Word Captions
-<ElementPage definition={elementDefinitions['captions/popping-word-captions']} sourceFile="./popping-word-captions.tsx" />
+<ElementPage definition={getElementDefinition('captions/popping-word-captions')} sourceFile="./popping-word-captions.tsx" />
diff --git a/packages/docs/elements/captions/word-highlight-captions/index.mdx b/packages/docs/elements/captions/word-highlight-captions/index.mdx
index 0c5b6aa5d3..6c3158f2b1 100644
--- a/packages/docs/elements/captions/word-highlight-captions/index.mdx
+++ b/packages/docs/elements/captions/word-highlight-captions/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/captions-word-highlight-captions-preview.
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Word Highlight Captions
-<ElementPage definition={elementDefinitions['captions/word-highlight-captions']} sourceFile="./word-highlight-captions.tsx" />
+<ElementPage definition={getElementDefinition('captions/word-highlight-captions')} sourceFile="./word-highlight-captions.tsx" />
diff --git a/packages/docs/elements/commerce/product-collection/index.mdx b/packages/docs/elements/commerce/product-collection/index.mdx
index 543c766acc..9b40b61418 100644
--- a/packages/docs/elements/commerce/product-collection/index.mdx
+++ b/packages/docs/elements/commerce/product-collection/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/commerce-product-collection-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Product Collection
-<ElementPage definition={elementDefinitions['commerce/product-collection']} sourceFile="./product-collection.tsx" />
+<ElementPage definition={getElementDefinition('commerce/product-collection')} sourceFile="./product-collection.tsx" />
diff --git a/packages/docs/elements/commerce/product-discount-callout/index.mdx b/packages/docs/elements/commerce/product-discount-callout/index.mdx
index c0e61b8b33..2d32cf4726 100644
--- a/packages/docs/elements/commerce/product-discount-callout/index.mdx
+++ b/packages/docs/elements/commerce/product-discount-callout/index.mdx
@@ -5,10 +5,10 @@ image: https://remotion.media/elements/commerce-product-discount-callout-preview
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Product Discount Callout
-<ElementPage definition={elementDefinitions['commerce/product-discount-callout']} sourceFile="./product-discount-callout.tsx" />
+<ElementPage definition={getElementDefinition('commerce/product-discount-callout')} sourceFile="./product-discount-callout.tsx" />
The default product image is adapted from [a photo by Andrey Matveev on Pexels](https://www.pexels.com/photo/gray-shoe-on-gray-background-27361691/) under the [Pexels license](https://www.pexels.com/license/). The background was removed.
diff --git a/packages/docs/elements/commerce/product-offer/index.mdx b/packages/docs/elements/commerce/product-offer/index.mdx
index 60cb2b5fef..5f5a1a34a1 100644
--- a/packages/docs/elements/commerce/product-offer/index.mdx
+++ b/packages/docs/elements/commerce/product-offer/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/commerce-product-offer-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Product Offer
-<ElementPage definition={elementDefinitions['commerce/product-offer']} sourceFile="./product-offer.tsx" />
+<ElementPage definition={getElementDefinition('commerce/product-offer')} sourceFile="./product-offer.tsx" />
diff --git a/packages/docs/elements/data/horizontal-bar-chart/index.mdx b/packages/docs/elements/data/horizontal-bar-chart/index.mdx
index d034ad6076..97fff2e90e 100644
--- a/packages/docs/elements/data/horizontal-bar-chart/index.mdx
+++ b/packages/docs/elements/data/horizontal-bar-chart/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/data-horizontal-bar-chart-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Horizontal Bar Chart
-<ElementPage definition={elementDefinitions['data/horizontal-bar-chart']} sourceFile="./horizontal-bar-chart.tsx" />
+<ElementPage definition={getElementDefinition('data/horizontal-bar-chart')} sourceFile="./horizontal-bar-chart.tsx" />
diff --git a/packages/docs/elements/data/line-chart/index.mdx b/packages/docs/elements/data/line-chart/index.mdx
index ad482e433d..32d1771294 100644
--- a/packages/docs/elements/data/line-chart/index.mdx
+++ b/packages/docs/elements/data/line-chart/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/data-line-chart-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Line Chart
-<ElementPage definition={elementDefinitions['data/line-chart']} sourceFile="./line-chart.tsx" />
+<ElementPage definition={getElementDefinition('data/line-chart')} sourceFile="./line-chart.tsx" />
diff --git a/packages/docs/elements/data/number-counter/index.mdx b/packages/docs/elements/data/number-counter/index.mdx
index ba30f78e00..4eca67ae61 100644
--- a/packages/docs/elements/data/number-counter/index.mdx
+++ b/packages/docs/elements/data/number-counter/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/data-number-counter-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Number Counter
-<ElementPage definition={elementDefinitions['data/number-counter']} sourceFile="./number-counter.tsx" />
+<ElementPage definition={getElementDefinition('data/number-counter')} sourceFile="./number-counter.tsx" />
diff --git a/packages/docs/elements/data/pie-chart/index.mdx b/packages/docs/elements/data/pie-chart/index.mdx
index cf9dea83d4..d0ccae4ea9 100644
--- a/packages/docs/elements/data/pie-chart/index.mdx
+++ b/packages/docs/elements/data/pie-chart/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/data-pie-chart-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Pie Chart
-<ElementPage definition={elementDefinitions['data/pie-chart']} sourceFile="./pie-chart.tsx" />
+<ElementPage definition={getElementDefinition('data/pie-chart')} sourceFile="./pie-chart.tsx" />
diff --git a/packages/docs/elements/data/vertical-bar-chart/index.mdx b/packages/docs/elements/data/vertical-bar-chart/index.mdx
index 84baf60e96..d86d0c8a7c 100644
--- a/packages/docs/elements/data/vertical-bar-chart/index.mdx
+++ b/packages/docs/elements/data/vertical-bar-chart/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/data-vertical-bar-chart-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Vertical Bar Chart
-<ElementPage definition={elementDefinitions['data/vertical-bar-chart']} sourceFile="./vertical-bar-chart.tsx" />
+<ElementPage definition={getElementDefinition('data/vertical-bar-chart')} sourceFile="./vertical-bar-chart.tsx" />
diff --git a/packages/docs/elements/maps/map-flyover/index.mdx b/packages/docs/elements/maps/map-flyover/index.mdx
index 2be6454c1d..38d5910c25 100644
--- a/packages/docs/elements/maps/map-flyover/index.mdx
+++ b/packages/docs/elements/maps/map-flyover/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/maps-map-flyover-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# A-to-B Map Flyover
-<ElementPage definition={elementDefinitions['maps/map-flyover']} sourceFile="./a-to-b-map-flyover.tsx" />
+<ElementPage definition={getElementDefinition('maps/map-flyover')} sourceFile="./a-to-b-map-flyover.tsx" />
diff --git a/packages/docs/elements/maps/watercolor-map/index.mdx b/packages/docs/elements/maps/watercolor-map/index.mdx
index cb8b361105..5a199ba427 100644
--- a/packages/docs/elements/maps/watercolor-map/index.mdx
+++ b/packages/docs/elements/maps/watercolor-map/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/maps-watercolor-map-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Watercolor Map
-<ElementPage definition={elementDefinitions['maps/watercolor-map']} sourceFile="./watercolor-map.tsx" />
+<ElementPage definition={getElementDefinition('maps/watercolor-map')} sourceFile="./watercolor-map.tsx" />
diff --git a/packages/docs/elements/overlays/location-lower-third/index.mdx b/packages/docs/elements/overlays/location-lower-third/index.mdx
index 34de06f16e..57d13c4d79 100644
--- a/packages/docs/elements/overlays/location-lower-third/index.mdx
+++ b/packages/docs/elements/overlays/location-lower-third/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/overlays-location-lower-third-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Location Lower Third
-<ElementPage definition={elementDefinitions['overlays/location-lower-third']} sourceFile="./location-lower-third.tsx" />
+<ElementPage definition={getElementDefinition('overlays/location-lower-third')} sourceFile="./location-lower-third.tsx" />
diff --git a/packages/docs/elements/overlays/name-lower-third/index.mdx b/packages/docs/elements/overlays/name-lower-third/index.mdx
index 0e67dadfcf..4c4032e3af 100644
--- a/packages/docs/elements/overlays/name-lower-third/index.mdx
+++ b/packages/docs/elements/overlays/name-lower-third/index.mdx
@@ -5,8 +5,8 @@ image: https://remotion.media/elements/overlays-name-lower-third-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Name Lower Third
-<ElementPage definition={elementDefinitions['overlays/name-lower-third']} sourceFile="./name-lower-third.tsx" />
+<ElementPage definition={getElementDefinition('overlays/name-lower-third')} sourceFile="./name-lower-third.tsx" />
diff --git a/packages/docs/elements/overlays/social-safe-zones/index.mdx b/packages/docs/elements/overlays/social-safe-zones/index.mdx
index 6dc71b9087..7fb292603c 100644
--- a/packages/docs/elements/overlays/social-safe-zones/index.mdx
+++ b/packages/docs/elements/overlays/social-safe-zones/index.mdx
@@ -5,11 +5,11 @@ image: https://remotion.media/elements/overlays-social-safe-zones-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# Social Safe Zones
-<ElementPage definition={elementDefinitions['overlays/social-safe-zones']} sourceFile="./social-safe-zones.tsx" />
+<ElementPage definition={getElementDefinition('overlays/social-safe-zones')} sourceFile="./social-safe-zones.tsx" />
## Accuracy
diff --git a/packages/docs/elements/storytelling/on-screen-messages/index.mdx b/packages/docs/elements/storytelling/on-screen-messages/index.mdx
index 43f8d2954b..ba87f8d3bf 100644
--- a/packages/docs/elements/storytelling/on-screen-messages/index.mdx
+++ b/packages/docs/elements/storytelling/on-screen-messages/index.mdx
@@ -4,9 +4,9 @@ description: An iMessage-inspired text exchange with staggered reveals, focus sh
image: https://remotion.media/elements/storytelling-on-screen-messages-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# On-Screen Messages
-<ElementPage definition={elementDefinitions['storytelling/on-screen-messages']} sourceFile="./on-screen-messages.tsx" />
+<ElementPage definition={getElementDefinition('storytelling/on-screen-messages')} sourceFile="./on-screen-messages.tsx" />
diff --git a/packages/docs/elements/storytelling/polaroid-pictures/index.mdx b/packages/docs/elements/storytelling/polaroid-pictures/index.mdx
index a16f0401b0..e1c2e2dbbc 100644
--- a/packages/docs/elements/storytelling/polaroid-pictures/index.mdx
+++ b/packages/docs/elements/storytelling/polaroid-pictures/index.mdx
@@ -4,9 +4,9 @@ description: A staggered instant-photo montage with handwritten captions, paper
image: https://remotion.media/elements/storytelling-polaroid-pictures-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Polaroid Pictures
-<ElementPage definition={elementDefinitions['storytelling/polaroid-pictures']} sourceFile="./polaroid-pictures.tsx" />
+<ElementPage definition={getElementDefinition('storytelling/polaroid-pictures')} sourceFile="./polaroid-pictures.tsx" />
diff --git a/packages/docs/elements/text/circle-marker/index.mdx b/packages/docs/elements/text/circle-marker/index.mdx
index fa2b098841..93b52d580b 100644
--- a/packages/docs/elements/text/circle-marker/index.mdx
+++ b/packages/docs/elements/text/circle-marker/index.mdx
@@ -4,9 +4,9 @@ description: An animated hand-drawn circle around text.
image: https://remotion.media/elements/text-circle-marker-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Circle Marker
-<ElementPage definition={elementDefinitions['text/circle-marker']} sourceFile="./circle-marker.tsx" />
+<ElementPage definition={getElementDefinition('text/circle-marker')} sourceFile="./circle-marker.tsx" />
diff --git a/packages/docs/elements/text/crossed-off/index.mdx b/packages/docs/elements/text/crossed-off/index.mdx
index 2b43231ca8..d4824257e8 100644
--- a/packages/docs/elements/text/crossed-off/index.mdx
+++ b/packages/docs/elements/text/crossed-off/index.mdx
@@ -4,9 +4,9 @@ description: Animated hand-drawn crossed-off text.
image: https://remotion.media/elements/text-crossed-off-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Crossed Off
-<ElementPage definition={elementDefinitions['text/crossed-off']} sourceFile="./crossed-off.tsx" />
+<ElementPage definition={getElementDefinition('text/crossed-off')} sourceFile="./crossed-off.tsx" />
diff --git a/packages/docs/elements/text/news-article-highlight/index.mdx b/packages/docs/elements/text/news-article-highlight/index.mdx
index 56398bf141..ca3e5d8e77 100644
--- a/packages/docs/elements/text/news-article-highlight/index.mdx
+++ b/packages/docs/elements/text/news-article-highlight/index.mdx
@@ -4,9 +4,9 @@ description: A news article camera treatment with animated highlights for drawin
image: https://remotion.media/elements/text-news-article-highlight-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# News Article Highlight
-<ElementPage definition={elementDefinitions['text/news-article-highlight']} sourceFile="./news-article-highlight.tsx" />
+<ElementPage definition={getElementDefinition('text/news-article-highlight')} sourceFile="./news-article-highlight.tsx" />
diff --git a/packages/docs/elements/text/spinning-text-wheel/index.mdx b/packages/docs/elements/text/spinning-text-wheel/index.mdx
index cb620fe051..c9618df175 100644
--- a/packages/docs/elements/text/spinning-text-wheel/index.mdx
+++ b/packages/docs/elements/text/spinning-text-wheel/index.mdx
@@ -4,9 +4,9 @@ description: A 3D text wheel that spins through options and decelerates onto a h
image: https://remotion.media/elements/text-spinning-text-wheel-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Spinning Text Wheel
-<ElementPage definition={elementDefinitions['text/spinning-text-wheel']} sourceFile="./spinning-text-wheel.tsx" />
+<ElementPage definition={getElementDefinition('text/spinning-text-wheel')} sourceFile="./spinning-text-wheel.tsx" />
diff --git a/packages/docs/elements/text/strike-through/index.mdx b/packages/docs/elements/text/strike-through/index.mdx
index 7272cb3acc..34a74c0403 100644
--- a/packages/docs/elements/text/strike-through/index.mdx
+++ b/packages/docs/elements/text/strike-through/index.mdx
@@ -4,9 +4,9 @@ description: Animated hand-drawn strike-through text.
image: https://remotion.media/elements/text-strike-through-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Strike Through
-<ElementPage definition={elementDefinitions['text/strike-through']} sourceFile="./strike-through.tsx" />
+<ElementPage definition={getElementDefinition('text/strike-through')} sourceFile="./strike-through.tsx" />
diff --git a/packages/docs/elements/text/text-marker/index.mdx b/packages/docs/elements/text/text-marker/index.mdx
index b8e8c37297..9bbe7b3997 100644
--- a/packages/docs/elements/text/text-marker/index.mdx
+++ b/packages/docs/elements/text/text-marker/index.mdx
@@ -4,9 +4,9 @@ description: A hand-drawn animated text highlight.
image: https://remotion.media/elements/text-text-marker-preview.png
---
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
import {ElementPage} from '@site/src/components/Elements/ElementPage';
# Text Marker
-<ElementPage definition={elementDefinitions['text/text-marker']} sourceFile="./text-marker.tsx" />
+<ElementPage definition={getElementDefinition('text/text-marker')} sourceFile="./text-marker.tsx" />
diff --git a/packages/docs/elements/youtube/youtube-comment-highlight/index.mdx b/packages/docs/elements/youtube/youtube-comment-highlight/index.mdx
index 81fe4b4400..90bfb24d1f 100644
--- a/packages/docs/elements/youtube/youtube-comment-highlight/index.mdx
+++ b/packages/docs/elements/youtube/youtube-comment-highlight/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/youtube-youtube-comment-highlight-preview
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# YouTube Comment Highlight
-<ElementPage definition={elementDefinitions['youtube/youtube-comment-highlight']} sourceFile="./youtube-comment-highlight.tsx" />
+<ElementPage definition={getElementDefinition('youtube/youtube-comment-highlight')} sourceFile="./youtube-comment-highlight.tsx" />
diff --git a/packages/docs/elements/youtube/youtube-end-card/index.mdx b/packages/docs/elements/youtube/youtube-end-card/index.mdx
index 121522927e..8a5f2f88ae 100644
--- a/packages/docs/elements/youtube/youtube-end-card/index.mdx
+++ b/packages/docs/elements/youtube/youtube-end-card/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/overlays-social-endcard-preview.png
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# YouTube End Card
-<ElementPage definition={elementDefinitions['youtube/youtube-end-card']} sourceFile="./youtube-end-card.tsx" />
+<ElementPage definition={getElementDefinition('youtube/youtube-end-card')} sourceFile="./youtube-end-card.tsx" />
diff --git a/packages/docs/elements/youtube/youtube-subscribe-nudge/index.mdx b/packages/docs/elements/youtube/youtube-subscribe-nudge/index.mdx
index 347b40d9b8..8fb0d14a9a 100644
--- a/packages/docs/elements/youtube/youtube-subscribe-nudge/index.mdx
+++ b/packages/docs/elements/youtube/youtube-subscribe-nudge/index.mdx
@@ -6,8 +6,8 @@ image: https://remotion.media/elements/youtube-youtube-subscribe-nudge-preview.p
---
import {ElementPage} from '@site/src/components/Elements/ElementPage';
-import {elementDefinitions} from '@site/src/components/Elements/element-definitions';
+import {getElementDefinition} from '@site/src/components/Elements/element-utils';
# YouTube Subscribe Nudge
-<ElementPage definition={elementDefinitions['youtube/youtube-subscribe-nudge']} sourceFile="./youtube-subscribe-nudge.tsx" />
+<ElementPage definition={getElementDefinition('youtube/youtube-subscribe-nudge')} sourceFile="./youtube-subscribe-nudge.tsx" />
diff --git a/packages/docs/src/test/elements.test.ts b/packages/docs/src/test/elements.test.ts
index 45f8b68613..66fca5762a 100644
--- a/packages/docs/src/test/elements.test.ts
+++ b/packages/docs/src/test/elements.test.ts
@@ -1,8 +1,11 @@
import {describe, expect, test} from 'bun:test';
import {existsSync, readdirSync, readFileSync, statSync} from 'fs';
+import {createRequire} from 'module';
import path from 'path';
+import {pathToFileURL} from 'url';
import React from 'react';
import {renderToStaticMarkup} from 'react-dom/server';
+import * as jsxRuntime from 'react/jsx-runtime';
import elementSidebars from '../../elements-sidebars';
import {
expandElementSourceReferences,
@@ -223,6 +226,49 @@ describe('Elements must follow the colocated single-file format', () => {
}
});
+describe('Element MDX pages', () => {
+ test('resolves each page definition through its real MDX expression', async () => {
+ // Use the same MDX compiler as Docusaurus.
+ const requireFromDocusaurus = createRequire(
+ require.resolve('@docusaurus/core/package.json'),
+ );
+ const requireFromMdxLoader = createRequire(
+ requireFromDocusaurus.resolve('@docusaurus/mdx-loader'),
+ );
+ const {evaluate} = requireFromMdxLoader('@mdx-js/mdx');
+ for (const element of productionElements) {
+ const source = readFileSync(element.mdxPath, 'utf8')
+ .replace(/^---[\s\S]*?---\s*/, '')
+ // Keep the page's imports and definition expression real; replace only the
+ // Docusaurus UI, which requires its build-generated module aliases.
+ .replace(/import \{ElementPage\} from '[^']+';/, '')
+ .replaceAll(
+ '@site/',
+ pathToFileURL(path.join(elementsRoot, '..')).href + '/',
+ );
+ const {default: Page} = await evaluate(source, {
+ ...jsxRuntime,
+ baseUrl: pathToFileURL(element.mdxPath),
+ });
+ const markup = renderToStaticMarkup(
+ React.createElement(Page, {
+ components: {
+ ElementPage: ({
+ definition,
+ }: {
+ readonly definition: (typeof elementDefinitions)[number];
+ }) => {
+ expect(definition.slug).toBe(element.name);
+ return React.createElement('span', null, definition.displayName);
+ },
+ },
+ }),
+ );
+ expect(markup).toContain(getElementDefinition(element.name).displayName);
+ }
+ });
+});
+
describe('Element library', () => {
test('injects the exact source files needed by each listing', () => {
const completeSourceCodeBySlug = getRemotionElementSourceMap({