Skip to content

Production-ready animations, transitions, backgrounds, and scenes for Remotion

feat: improve docs written

dev_wandry33547ae5f761
diff --git a/content/docs/components.mdx b/content/docs/components.mdx
index d828669a..e720a1ec 100644
--- a/content/docs/components.mdx
+++ b/content/docs/components.mdx
@@ -1,6 +1,6 @@
---
title: Components
-description: Every component in remocn, grouped by category.
+description: Every component in remocn, grouped by category
---
A complete index of every component in remocn. Browse by category or jump straight to the one you need.
@@ -15,25 +15,25 @@ Text effects, reveals, and kinetic type.
items={[
{
name: "BlurReveal",
- description: "Text fades in from a heavy blur into sharp focus.",
+ description: "Text fades in from a heavy blur into sharp focus",
status: "stable",
href: "/docs/typography/blur-reveal",
},
{
name: "StaggeredFadeUp",
- description: "Words rise from below with a soft cascading delay.",
+ description: "Words rise from below with a soft cascading delay",
status: "stable",
href: "/docs/typography/staggered-fade-up",
},
{
name: "MaskedSlideReveal",
- description: "Lines grow out from behind an invisible horizontal mask.",
+ description: "Lines grow out from behind an invisible horizontal mask",
status: "stable",
href: "/docs/typography/masked-slide-reveal",
},
{
name: "TrackingIn",
- description: "Letter-spacing collapses from wide to normal with a spring snap.",
+ description: "Letter-spacing collapses from wide to normal with a spring snap",
status: "stable",
href: "/docs/typography/tracking-in",
},
@@ -46,19 +46,19 @@ Text effects, reveals, and kinetic type.
items={[
{
name: "InlineHighlight",
- description: "Animates one word inside a sentence from a base color to a brand color.",
+ description: "Animates one word inside a sentence from a base color to a brand color",
status: "stable",
href: "/docs/typography/inline-highlight",
},
{
name: "MarkerHighlight",
- description: "Marker bar sweeps in behind a phrase, optionally inverting the text color.",
+ description: "Marker bar sweeps in behind a phrase, optionally inverting the text color",
status: "stable",
href: "/docs/typography/marker-highlight",
},
{
name: "ShimmerSweep",
- description: "Bright gradient sweeps across dim text, lighting it up.",
+ description: "Bright gradient sweeps across dim text, lighting it up",
status: "stable",
href: "/docs/typography/shimmer-sweep",
},
@@ -71,7 +71,7 @@ Text effects, reveals, and kinetic type.
items={[
{
name: "Typewriter",
- description: "Character-by-character text reveal with a deterministic blinking cursor.",
+ description: "Character-by-character text reveal with a deterministic blinking cursor",
status: "stable",
href: "/docs/typography/typewriter",
},
@@ -83,7 +83,7 @@ Text effects, reveals, and kinetic type.
},
{
name: "SlotMachineRoll",
- description: "Numbers and characters roll into place like a casino reel.",
+ description: "Numbers and characters roll into place like a casino reel",
status: "stable",
href: "/docs/typography/slot-machine-roll",
},
@@ -96,13 +96,13 @@ Text effects, reveals, and kinetic type.
items={[
{
name: "InfiniteMarquee",
- description: "Endlessly scrolling horizontal text band.",
+ description: "Endlessly scrolling horizontal text band",
status: "stable",
href: "/docs/typography/infinite-marquee",
},
{
name: "PerspectiveMarquee",
- description: "Marquee tilted into 3D space with depth fade.",
+ description: "Marquee tilted into 3D space with depth fade",
status: "stable",
href: "/docs/typography/perspective-marquee",
},
@@ -115,13 +115,13 @@ Text effects, reveals, and kinetic type.
items={[
{
name: "MatrixDecode",
- description: "Random characters scramble and resolve into the target string.",
+ description: "Random characters scramble and resolve into the target string",
status: "stable",
href: "/docs/typography/matrix-decode",
},
{
name: "RGBGlitchText",
- description: "Three-channel RGB split with a brief horizontal jitter.",
+ description: "Three-channel RGB split with a brief horizontal jitter",
status: "stable",
href: "/docs/typography/rgb-glitch-text",
},
@@ -138,19 +138,19 @@ Foundational micro-interactions and reusable building blocks.
items={[
{
name: "SpringPopIn",
- description: "Elastic scale pop with configurable overshoot.",
+ description: "Elastic scale pop with configurable overshoot",
status: "stable",
href: "/docs/primitives/spring-pop-in",
},
{
name: "PulsingIndicator",
- description: "Continuous sine-driven pulse for loading or activity states.",
+ description: "Continuous sine-driven pulse for loading or activity states",
status: "stable",
href: "/docs/primitives/pulsing-indicator",
},
{
name: "SuccessConfetti",
- description: "Deterministic particle burst from a chosen origin point.",
+ description: "Deterministic particle burst from a chosen origin point",
status: "stable",
href: "/docs/primitives/success-confetti",
},
@@ -169,13 +169,13 @@ Foundational micro-interactions and reusable building blocks.
},
{
name: "BoundingBoxSelector",
- description: "Figma-style selection rectangle that snaps around a target.",
+ description: "Figma-style selection rectangle that snaps around a target",
status: "stable",
href: "/docs/primitives/bounding-box-selector",
},
{
name: "ToastNotification",
- description: "System toast that springs in, holds, and slides away.",
+ description: "System toast that springs in, holds, and slides away",
status: "stable",
href: "/docs/primitives/toast-notification",
},
@@ -192,13 +192,13 @@ Backgrounds, lighting, and atmosphere for your scenes.
items={[
{
name: "MeshGradientBg",
- description: "Living gradient where soft color blobs drift on noise-driven coordinates.",
+ description: "Living gradient where soft color blobs drift on noise-driven coordinates",
status: "stable",
href: "/docs/environment/mesh-gradient-bg",
},
{
name: "DynamicGrid",
- description: "Subtle moving grid or dot pattern background.",
+ description: "Subtle moving grid or dot pattern background",
status: "stable",
href: "/docs/environment/dynamic-grid",
},
@@ -211,7 +211,7 @@ Backgrounds, lighting, and atmosphere for your scenes.
items={[
{
name: "SpotlightCard",
- description: "Cursor-tracked radial light that rims a card and lifts it from the dark.",
+ description: "Cursor-tracked radial light that rims a card and lifts it from the dark",
status: "stable",
href: "/docs/environment/spotlight-card",
},
@@ -220,7 +220,7 @@ Backgrounds, lighting, and atmosphere for your scenes.
## UI Blocks
-Pre-assembled interface elements — code editors, layouts, charts, and workflow visualizations.
+Pre-assembled interface elements: code editors, layouts, charts, and workflow visualizations.
### Code & CLI
@@ -228,25 +228,25 @@ Pre-assembled interface elements — code editors, layouts, charts, and workflow
items={[
{
name: "GlassCodeBlock",
- description: "Premium frosted-glass code window with rim light and traffic-light controls.",
+ description: "Premium frosted-glass code window with rim light and traffic-light controls",
status: "stable",
href: "/docs/ui-blocks/glass-code-block",
},
{
name: "TerminalSimulator",
- description: "CLI build simulation with chunked log output and step-function scrolling.",
+ description: "CLI build simulation with chunked log output and step-function scrolling",
status: "stable",
href: "/docs/ui-blocks/terminal-simulator",
},
{
name: "CodeAccordion",
- description: "Long code blocks collapse mid-section, hiding noise behind a count badge.",
+ description: "Long code blocks collapse mid-section, hiding noise behind a count badge",
status: "stable",
href: "/docs/ui-blocks/code-accordion",
},
{
name: "CodeDiffWipe",
- description: "Before/after comparison with a clip-path slider revealing the new code.",
+ description: "Before/after comparison with a clip-path slider revealing the new code",
status: "stable",
href: "/docs/ui-blocks/code-diff-wipe",
},
@@ -259,13 +259,13 @@ Pre-assembled interface elements — code editors, layouts, charts, and workflow
items={[
{
name: "StaggeredBentoGrid",
- description: "Bento grid where cards cascade in with per-cell sequences.",
+ description: "Bento grid where cards cascade in with per-cell sequences",
status: "stable",
href: "/docs/ui-blocks/staggered-bento-grid",
},
{
name: "DynamicSplitScreen",
- description: "Two-column split where one panel shrinks and the other expands into view.",
+ description: "Two-column split where one panel shrinks and the other expands into view",
status: "stable",
href: "/docs/ui-blocks/dynamic-split-screen",
},
@@ -278,19 +278,19 @@ Pre-assembled interface elements — code editors, layouts, charts, and workflow
items={[
{
name: "AnimatedLineChart",
- description: "SVG line chart drawn left-to-right via stroke-dashoffset.",
+ description: "SVG line chart drawn left-to-right via stroke-dashoffset",
status: "stable",
href: "/docs/ui-blocks/animated-line-chart",
},
{
name: "AnimatedBarChart",
- description: "Bars spring up from the baseline with deterministic stagger.",
+ description: "Bars spring up from the baseline with deterministic stagger",
status: "stable",
href: "/docs/ui-blocks/animated-bar-chart",
},
{
name: "DataFlowPipes",
- description: "Glowing data packets fly along SVG pipes with trailing tails.",
+ description: "Glowing data packets fly along SVG pipes with trailing tails",
status: "stable",
href: "/docs/ui-blocks/data-flow-pipes",
},
@@ -303,13 +303,13 @@ Pre-assembled interface elements — code editors, layouts, charts, and workflow
items={[
{
name: "ProgressSteps",
- description: "Multi-step pipeline visualization with line fill and pulsing dots.",
+ description: "Multi-step pipeline visualization with line fill and pulsing dots",
status: "stable",
href: "/docs/ui-blocks/progress-steps",
},
{
name: "DragAndDropFlow",
- description: "Cursor drags a file into a drop zone that lights up and starts a progress bar.",
+ description: "Cursor drags a file into a drop zone that lights up and starts a progress bar",
status: "stable",
href: "/docs/ui-blocks/drag-and-drop-flow",
},
@@ -326,19 +326,19 @@ Scene transitions, camera moves, and stylized wipes.
items={[
{
name: "ZoomThroughTransition",
- description: "Aggressive scale-in 'through' an element to the next scene.",
+ description: "Aggressive scale-in 'through' an element to the next scene",
status: "stable",
href: "/docs/transitions/zoom-through-transition",
},
{
name: "DeviceMockupZoom",
- description: "Pull back from a UI to reveal it inside a phone or laptop frame.",
+ description: "Pull back from a UI to reveal it inside a phone or laptop frame",
status: "stable",
href: "/docs/transitions/device-mockup-zoom",
},
{
name: "MorphingModal",
- description: "Card lifts off a grid and expands into a full-screen modal.",
+ description: "Card lifts off a grid and expands into a full-screen modal",
status: "stable",
href: "/docs/transitions/morphing-modal",
},
@@ -351,25 +351,25 @@ Scene transitions, camera moves, and stylized wipes.
items={[
{
name: "DirectionalWipe",
- description: "Slide one scene in while pushing the other out.",
+ description: "Slide one scene in while pushing the other out",
status: "stable",
href: "/docs/transitions/directional-wipe",
},
{
name: "SpatialPush",
- description: "A new scene physically presses the old one back into the frame.",
+ description: "A new scene physically presses the old one back into the frame",
status: "stable",
href: "/docs/transitions/spatial-push",
},
{
name: "FrostedGlassWipe",
- description: "Elegant scene transition through a sliding pane of frosted glass.",
+ description: "Elegant scene transition through a sliding pane of frosted glass",
status: "stable",
href: "/docs/transitions/frosted-glass-wipe",
},
{
name: "KineticTypeMask",
- description: "Use giant typography as a window into the next scene.",
+ description: "Use giant typography as a window into the next scene",
status: "stable",
href: "/docs/transitions/kinetic-type-mask",
},
@@ -382,13 +382,13 @@ Scene transitions, camera moves, and stylized wipes.
items={[
{
name: "GridPixelateWipe",
- description: "Dissolve from one scene to the next through a deterministic grid of mask cells.",
+ description: "Dissolve from one scene to the next through a deterministic grid of mask cells",
status: "stable",
href: "/docs/transitions/grid-pixelate-wipe",
},
{
name: "ChromaticAberrationWipe",
- description: "An ultra-fast slide transition with an RGB glitch on the peak frames.",
+ description: "An ultra-fast slide transition with an RGB glitch on the peak frames",
status: "stable",
href: "/docs/transitions/chromatic-aberration-wipe",
},
@@ -405,19 +405,19 @@ Full scenes built by composing primitives and UI blocks.
items={[
{
name: "HeroDeviceAssemble",
- description: "Floating device layers spring into a laptop or phone, then the screen wakes with a shimmer.",
+ description: "Floating device layers spring into a laptop or phone, then the screen wakes with a shimmer",
status: "stable",
href: "/docs/compositions/hero-device-assemble",
},
{
name: "EcosystemConstellation",
- description: "Central logo orbited by integration satellites with pulsing data lines.",
+ description: "Central logo orbited by integration satellites with pulsing data lines",
status: "stable",
href: "/docs/compositions/ecosystem-constellation",
},
{
name: "InfiniteBentoPan",
- description: "Camera diagonally drifts across an oversized bento grid behind a soft vignette.",
+ description: "Camera diagonally drifts across an oversized bento grid behind a soft vignette",
status: "stable",
href: "/docs/compositions/infinite-bento-pan",
},
@@ -430,25 +430,25 @@ Full scenes built by composing primitives and UI blocks.
items={[
{
name: "BrowserFlow",
- description: "Full Safari/Chrome simulation: URL typing, loading bar, scroll, and click.",
+ description: "Full Safari/Chrome simulation: URL typing, loading bar, scroll, and click",
status: "stable",
href: "/docs/compositions/browser-flow",
},
{
name: "AIGenerationCanvas",
- description: "Prompt input morphs into a header, then a skeleton dashboard flips into populated cards.",
+ description: "Prompt input morphs into a header, then a skeleton dashboard flips into populated cards",
status: "stable",
href: "/docs/compositions/ai-generation-canvas",
},
{
name: "LiveCodeCompilation",
- description: "Split-screen where typed code on the left snaps a live UI preview on the right.",
+ description: "Split-screen where typed code on the left snaps a live UI preview on the right",
status: "stable",
href: "/docs/compositions/live-code-compilation",
},
{
name: "TerminalToBrowserDeploy",
- description: "CLI deploy completes, terminal blurs back, and a browser window springs from the deploy URL.",
+ description: "CLI deploy completes, terminal blurs back, and a browser window springs from the deploy URL",
status: "stable",
href: "/docs/compositions/terminal-to-browser-deploy",
},
@@ -461,19 +461,19 @@ Full scenes built by composing primitives and UI blocks.
items={[
{
name: "DashboardPopulate",
- description: "Empty dashboard cascades to life with KPI count-ups, bar bounces, line traces, and a donut fill.",
+ description: "Empty dashboard cascades to life with KPI count-ups, bar bounces, line traces, and a donut fill",
status: "stable",
href: "/docs/compositions/dashboard-populate",
},
{
name: "PipelineJourney",
- description: "Kanban ticket flies between columns, triggering events on landing.",
+ description: "Kanban ticket flies between columns, triggering events on landing",
status: "stable",
href: "/docs/compositions/pipeline-journey",
},
{
name: "PricingTierFocus",
- description: "Three pricing cards where the focused tier rises and brightens while siblings dim and blur.",
+ description: "Three pricing cards where the focused tier rises and brightens while siblings dim and blur",
status: "stable",
href: "/docs/compositions/pricing-tier-focus",
},
diff --git a/content/docs/compositions/ai-generation-canvas.mdx b/content/docs/compositions/ai-generation-canvas.mdx
index 94600f37..61133ac5 100644
--- a/content/docs/compositions/ai-generation-canvas.mdx
+++ b/content/docs/compositions/ai-generation-canvas.mdx
@@ -1,6 +1,6 @@
---
title: AI Generation Canvas
-description: A prompt input morphs into a dashboard header, then skeletons flip to reveal generated content.
+description: A prompt input morphs into a dashboard header, then skeletons flip to reveal generated content
---
<ComponentPreview name="ai-generation-canvas" />
@@ -44,24 +44,24 @@ export const RemotionRoot = () => (
name: "prompt",
type: "string",
default: '"Generate a dashboard"',
- description: "Text typed into the input during the first phase.",
+ description: "Text typed into the input during the first phase",
},
{
name: "accentColor",
type: "string",
default: '"#7c3aed"',
- description: "Brand color used for the input border, shimmer tint, and chart accents.",
+ description: "Brand color used for the input border, shimmer tint, and chart accents",
},
{
name: "cardCount",
type: "number",
default: "4",
- description: "Number of skeleton cards rendered and revealed in the dashboard grid.",
+ description: "Number of skeleton cards rendered and revealed in the dashboard grid",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/browser-flow.mdx b/content/docs/compositions/browser-flow.mdx
index a95bfff6..48da2d2a 100644
--- a/content/docs/compositions/browser-flow.mdx
+++ b/content/docs/compositions/browser-flow.mdx
@@ -1,6 +1,6 @@
---
title: Browser Flow
-description: A full Safari/Chrome simulation from URL typing to scroll and click.
+description: A full Safari/Chrome simulation from URL typing to scroll and click
---
<ComponentPreview name="browser-flow" />
@@ -40,18 +40,18 @@ export const RemotionRoot = () => (
name: "url",
type: "string",
default: '"remocn.dev"',
- description: "The URL typed into the address bar and used in the autocomplete suggestion.",
+ description: "The URL typed into the address bar and used in the autocomplete suggestion",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame to slow down or speed up the entire sequence.",
+ description: "Multiplier applied to the current frame to slow down or speed up the entire sequence",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/changelog-bite.mdx b/content/docs/compositions/changelog-bite.mdx
index 8511b590..3121bf83 100644
--- a/content/docs/compositions/changelog-bite.mdx
+++ b/content/docs/compositions/changelog-bite.mdx
@@ -1,6 +1,6 @@
---
title: Changelog Bite
-description: Seamlessly looping square card showing a before/after diff with a frosted glass wipe and a pulsing New pill.
+description: Seamlessly looping square card showing a before/after diff with a frosted glass wipe and a pulsing New pill
---
<ComponentPreview name="changelog-bite" />
@@ -40,15 +40,15 @@ export const RemotionRoot = () => (
<PropsTable
rows={[
- { name: "label", type: "string", default: '"New"', description: "Text shown inside the pulsing pill." },
- { name: "title", type: "string", default: '"Inline diff view"', description: "Caption rendered above the diff stage." },
+ { name: "label", type: "string", default: '"New"', description: "Text shown inside the pulsing pill" },
+ { name: "title", type: "string", default: '"Inline diff view"', description: "Caption rendered above the diff stage" },
{ name: "oldContent", type: "ReactNode", description: "Custom before content. Defaults to a simple code panel." },
{ name: "newContent", type: "ReactNode", description: "Custom after content. Defaults to a polished code panel." },
{ name: "format", type: '"square" | "portrait"', default: '"square"', description: "Aspect ratio of the inner card. Set the matching `compositionWidth/compositionHeight` on your <Composition>." },
- { name: "background", type: "string", default: '"#141318"', description: "Stage background color." },
- { name: "cardBackground", type: "string", default: '"rgba(20, 19, 24, 0.92)"', description: "Card fill color." },
- { name: "accent", type: "string", default: '"#FFB38E"', description: "Accent color for the pill, seam, and badges." },
- { name: "speed", type: "number", default: "1", description: "Playback speed multiplier." },
- { name: "className", type: "string", description: "Optional className for the outer container." },
+ { name: "background", type: "string", default: '"#141318"', description: "Stage background color" },
+ { name: "cardBackground", type: "string", default: '"rgba(20, 19, 24, 0.92)"', description: "Card fill color" },
+ { name: "accent", type: "string", default: '"#FFB38E"', description: "Accent color for the pill, seam, and badges" },
+ { name: "speed", type: "number", default: "1", description: "Playback speed multiplier" },
+ { name: "className", type: "string", description: "Optional className for the outer container" },
]}
/>
diff --git a/content/docs/compositions/dashboard-populate.mdx b/content/docs/compositions/dashboard-populate.mdx
index 5979343e..ef0d16e2 100644
--- a/content/docs/compositions/dashboard-populate.mdx
+++ b/content/docs/compositions/dashboard-populate.mdx
@@ -1,6 +1,6 @@
---
title: Dashboard Populate
-description: An empty dashboard fills itself with data in a cascaded spring sequence.
+description: An empty dashboard fills itself with data in a cascaded spring sequence
---
<ComponentPreview name="dashboard-populate" />
@@ -40,24 +40,24 @@ export const RemotionRoot = () => (
name: "accentColor",
type: "string",
default: '"#22c55e"',
- description: "Color used for bars, line, donut and KPI delta.",
+ description: "Color used for bars, line, donut and KPI delta",
},
{
name: "kpiTarget",
type: "number",
default: "128400",
- description: "Target value the revenue counter animates up to.",
+ description: "Target value the revenue counter animates up to",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame.",
+ description: "Multiplier applied to the current frame",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/ecosystem-constellation.mdx b/content/docs/compositions/ecosystem-constellation.mdx
index 325a72b4..6e445882 100644
--- a/content/docs/compositions/ecosystem-constellation.mdx
+++ b/content/docs/compositions/ecosystem-constellation.mdx
@@ -1,6 +1,6 @@
---
title: Ecosystem Constellation
-description: A central product logo orbited by integration satellites with pulsing data lines.
+description: A central product logo orbited by integration satellites with pulsing data lines
---
<ComponentPreview name="ecosystem-constellation" />
@@ -44,24 +44,24 @@ export const RemotionRoot = () => (
name: "satelliteCount",
type: "number",
default: "6",
- description: "Number of orbiting integration satellites (clamped to 3..8).",
+ description: "Number of orbiting integration satellites (clamped to 3..8)",
},
{
name: "centerLabel",
type: "string",
default: '"V"',
- description: "Single character or short label rendered inside the central hub.",
+ description: "Single character or short label rendered inside the central hub",
},
{
name: "accentColor",
type: "string",
default: '"#a855f7"',
- description: "Color of the hub, glow, and connection lines.",
+ description: "Color of the hub, glow, and connection lines",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/hero-device-assemble.mdx b/content/docs/compositions/hero-device-assemble.mdx
index 60b5ed89..500eac39 100644
--- a/content/docs/compositions/hero-device-assemble.mdx
+++ b/content/docs/compositions/hero-device-assemble.mdx
@@ -1,6 +1,6 @@
---
title: Hero Device Assemble
-description: Layered device mockup that snaps together in 3D before the screen wakes up.
+description: Layered device mockup that snaps together in 3D before the screen wakes up
---
<ComponentPreview name="hero-device-assemble" />
@@ -50,18 +50,18 @@ export const RemotionRoot = () => (
name: "accentColor",
type: "string",
default: '"#22c55e"',
- description: "Brand accent applied to the in-screen UI highlights.",
+ description: "Brand accent applied to the in-screen UI highlights",
},
{
name: "assembleStart",
type: "number",
default: "0",
- description: "Frame at which the assembly spring kicks off.",
+ description: "Frame at which the assembly spring kicks off",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/index.mdx b/content/docs/compositions/index.mdx
index bbfb43e0..10744b82 100644
--- a/content/docs/compositions/index.mdx
+++ b/content/docs/compositions/index.mdx
@@ -1,9 +1,9 @@
---
title: Compositions
-description: Full scenes built by composing primitives and UI blocks.
+description: Full scenes built by composing primitives and UI blocks
---
-Higher-level templates that combine multiple primitives, UI blocks, and transitions into finished shots — heroes, product showcases, and journeys.
+Higher-level templates that combine multiple primitives, UI blocks, and transitions into finished shots: heroes, product showcases, and journeys.
## Hero & Outro
@@ -11,19 +11,19 @@ Higher-level templates that combine multiple primitives, UI blocks, and transiti
items={[
{
name: "HeroDeviceAssemble",
- description: "Floating device layers spring into a laptop or phone, then the screen wakes with a shimmer.",
+ description: "Floating device layers spring into a laptop or phone, then the screen wakes with a shimmer",
status: "stable",
href: "/docs/compositions/hero-device-assemble",
},
{
name: "EcosystemConstellation",
- description: "Central logo orbited by integration satellites with pulsing data lines.",
+ description: "Central logo orbited by integration satellites with pulsing data lines",
status: "stable",
href: "/docs/compositions/ecosystem-constellation",
},
{
name: "InfiniteBentoPan",
- description: "Camera diagonally drifts across an oversized bento grid behind a soft vignette.",
+ description: "Camera diagonally drifts across an oversized bento grid behind a soft vignette",
status: "stable",
href: "/docs/compositions/infinite-bento-pan",
},
@@ -36,25 +36,25 @@ Higher-level templates that combine multiple primitives, UI blocks, and transiti
items={[
{
name: "BrowserFlow",
- description: "Full Safari/Chrome simulation: URL typing, loading bar, scroll, and click.",
+ description: "Full Safari/Chrome simulation: URL typing, loading bar, scroll, and click",
status: "stable",
href: "/docs/compositions/browser-flow",
},
{
name: "AIGenerationCanvas",
- description: "Prompt input morphs into a header, then a skeleton dashboard flips into populated cards.",
+ description: "Prompt input morphs into a header, then a skeleton dashboard flips into populated cards",
status: "stable",
href: "/docs/compositions/ai-generation-canvas",
},
{
name: "LiveCodeCompilation",
- description: "Split-screen where typed code on the left snaps a live UI preview on the right.",
+ description: "Split-screen where typed code on the left snaps a live UI preview on the right",
status: "stable",
href: "/docs/compositions/live-code-compilation",
},
{
name: "TerminalToBrowserDeploy",
- description: "CLI deploy completes, terminal blurs back, and a browser window springs from the deploy URL.",
+ description: "CLI deploy completes, terminal blurs back, and a browser window springs from the deploy URL",
status: "stable",
href: "/docs/compositions/terminal-to-browser-deploy",
},
@@ -67,19 +67,19 @@ Higher-level templates that combine multiple primitives, UI blocks, and transiti
items={[
{
name: "DashboardPopulate",
- description: "Empty dashboard cascades to life with KPI count-ups, bar bounces, line traces, and a donut fill.",
+ description: "Empty dashboard cascades to life with KPI count-ups, bar bounces, line traces, and a donut fill",
status: "stable",
href: "/docs/compositions/dashboard-populate",
},
{
name: "PipelineJourney",
- description: "Kanban ticket flies between columns, triggering events on landing.",
+ description: "Kanban ticket flies between columns, triggering events on landing",
status: "stable",
href: "/docs/compositions/pipeline-journey",
},
{
name: "PricingTierFocus",
- description: "Three pricing cards where the focused tier rises and brightens while siblings dim and blur.",
+ description: "Three pricing cards where the focused tier rises and brightens while siblings dim and blur",
status: "stable",
href: "/docs/compositions/pricing-tier-focus",
},
diff --git a/content/docs/compositions/infinite-bento-pan.mdx b/content/docs/compositions/infinite-bento-pan.mdx
index 44868f0f..936ec071 100644
--- a/content/docs/compositions/infinite-bento-pan.mdx
+++ b/content/docs/compositions/infinite-bento-pan.mdx
@@ -1,6 +1,6 @@
---
title: Infinite Bento Pan
-description: A hypnotic diagonal camera glide over an oversized grid of bento cards.
+description: A hypnotic diagonal camera glide over an oversized grid of bento cards
---
<ComponentPreview name="infinite-bento-pan" />
@@ -46,18 +46,18 @@ export const RemotionRoot = () => (
name: "accentColor",
type: "string",
default: '"#7c3aed"',
- description: "Color used by chart strokes, bar fills, counters, and logo gradients.",
+ description: "Color used by chart strokes, bar fills, counters, and logo gradients",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame for global timing control.",
+ description: "Multiplier applied to the current frame for global timing control",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/live-code-compilation.mdx b/content/docs/compositions/live-code-compilation.mdx
index 5c9699ed..99cbd4f7 100644
--- a/content/docs/compositions/live-code-compilation.mdx
+++ b/content/docs/compositions/live-code-compilation.mdx
@@ -1,6 +1,6 @@
---
title: Live Code Compilation
-description: A split-screen where code is typed on the left and the right-side UI snaps to match in a single frame.
+description: A split-screen where code is typed on the left and the right-side UI snaps to match in a single frame
---
<ComponentPreview name="live-code-compilation" />
@@ -40,12 +40,12 @@ export const RemotionRoot = () => (
name: "accentColor",
type: "string",
default: '"#3b82f6"',
- description: "Color used for the JSX prop highlight, the HMR flash, and the default button background.",
+ description: "Color used for the JSX prop highlight, the HMR flash, and the default button background",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/pipeline-journey.mdx b/content/docs/compositions/pipeline-journey.mdx
index e080e2e0..2f745d1c 100644
--- a/content/docs/compositions/pipeline-journey.mdx
+++ b/content/docs/compositions/pipeline-journey.mdx
@@ -1,6 +1,6 @@
---
title: Pipeline Journey
-description: A Kanban ticket flies between columns, triggering events along the way.
+description: A Kanban ticket flies between columns, triggering events along the way
---
<ComponentPreview name="pipeline-journey" />
@@ -40,24 +40,24 @@ export const RemotionRoot = () => (
name: "cardLabel",
type: "string",
default: '"Build pipeline"',
- description: "Title shown on the flying ticket.",
+ description: "Title shown on the flying ticket",
},
{
name: "accentColor",
type: "string",
default: '"#22c55e"',
- description: "Color of the ticket border, status dot and confetti accent.",
+ description: "Color of the ticket border, status dot and confetti accent",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame.",
+ description: "Multiplier applied to the current frame",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/pricing-tier-focus.mdx b/content/docs/compositions/pricing-tier-focus.mdx
index 8ab78892..3ef47520 100644
--- a/content/docs/compositions/pricing-tier-focus.mdx
+++ b/content/docs/compositions/pricing-tier-focus.mdx
@@ -1,6 +1,6 @@
---
title: Pricing Tier Focus
-description: Highlight the recommended pricing tier by dimming and blurring its neighbors.
+description: Highlight the recommended pricing tier by dimming and blurring its neighbors
---
<ComponentPreview name="pricing-tier-focus" />
@@ -40,24 +40,24 @@ export const RemotionRoot = () => (
name: "focusedTier",
type: "0 | 1 | 2",
default: "1",
- description: "Index of the tier to highlight (0 = Free, 1 = Pro, 2 = Enterprise).",
+ description: "Index of the tier to highlight (0 = Free, 1 = Pro, 2 = Enterprise)",
},
{
name: "accentColor",
type: "string",
default: '"#22c55e"',
- description: "Brand color for the focused tier badge, checkmarks, and CTA button.",
+ description: "Brand color for the focused tier badge, checkmarks, and CTA button",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame for global timing control.",
+ description: "Multiplier applied to the current frame for global timing control",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/product-launch-trailer.mdx b/content/docs/compositions/product-launch-trailer.mdx
index 1ce5d9c3..77a2e4fb 100644
--- a/content/docs/compositions/product-launch-trailer.mdx
+++ b/content/docs/compositions/product-launch-trailer.mdx
@@ -1,6 +1,6 @@
---
title: Product Launch Trailer
-description: Cinematic Product Hunt teaser with logo pulse, zoom-through, 3D bento fly-over, and a confetti version drop.
+description: Cinematic Product Hunt teaser with logo pulse, zoom-through, 3D bento fly-over, and a confetti version drop
---
<ComponentPreview name="product-launch-trailer" />
@@ -40,14 +40,14 @@ export const RemotionRoot = () => (
<PropsTable
rows={[
- { name: "logoLabel", type: "string", default: '"R"', description: "Single-character mark shown inside the centered logo squircle." },
- { name: "productName", type: "string", default: '"Remocn"', description: "Subtitle rendered below the logo while it pulses." },
- { name: "versionLabel", type: "string", default: '"v1.0 is live"', description: "Headline that drops in during the outro." },
- { name: "accentPeach", type: "string", default: '"#FFB38E"', description: "Peach accent for bento card shadows and confetti." },
- { name: "accentLavender", type: "string", default: '"#D4B3FF"', description: "Lavender accent for the logo glow and code block border." },
- { name: "accentMint", type: "string", default: '"#A1EEBD"', description: "Mint accent for traffic lights and confetti." },
- { name: "background", type: "string", default: '"#141318"', description: "Stage background color." },
- { name: "speed", type: "number", default: "1", description: "Playback speed multiplier." },
- { name: "className", type: "string", description: "Optional className for the outer container." },
+ { name: "logoLabel", type: "string", default: '"R"', description: "Single-character mark shown inside the centered logo squircle" },
+ { name: "productName", type: "string", default: '"Remocn"', description: "Subtitle rendered below the logo while it pulses" },
+ { name: "versionLabel", type: "string", default: '"v1.0 is live"', description: "Headline that drops in during the outro" },
+ { name: "accentPeach", type: "string", default: '"#FFB38E"', description: "Peach accent for bento card shadows and confetti" },
+ { name: "accentLavender", type: "string", default: '"#D4B3FF"', description: "Lavender accent for the logo glow and code block border" },
+ { name: "accentMint", type: "string", default: '"#A1EEBD"', description: "Mint accent for traffic lights and confetti" },
+ { name: "background", type: "string", default: '"#141318"', description: "Stage background color" },
+ { name: "speed", type: "number", default: "1", description: "Playback speed multiplier" },
+ { name: "className", type: "string", description: "Optional className for the outer container" },
]}
/>
diff --git a/content/docs/compositions/terminal-to-browser-deploy.mdx b/content/docs/compositions/terminal-to-browser-deploy.mdx
index dbc0763a..2e70a8cb 100644
--- a/content/docs/compositions/terminal-to-browser-deploy.mdx
+++ b/content/docs/compositions/terminal-to-browser-deploy.mdx
@@ -1,6 +1,6 @@
---
title: Terminal To Browser Deploy
-description: A CLI deploy completes and the live site grows out of the URL printed in the console.
+description: A CLI deploy completes and the live site grows out of the URL printed in the console
---
<ComponentPreview name="terminal-to-browser-deploy" />
@@ -43,24 +43,24 @@ export const RemotionRoot = () => (
name: "siteUrl",
type: "string",
default: '"https://app.example.com"',
- description: "URL printed in the deploy success line and shown in the browser address bar.",
+ description: "URL printed in the deploy success line and shown in the browser address bar",
},
{
name: "accentColor",
type: "string",
default: '"#22c55e"',
- description: "Accent color used for the success line, CTA button, and ambient glow inside the browser.",
+ description: "Accent color used for the success line, CTA button, and ambient glow inside the browser",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier applied to the current frame to slow down or speed up the entire sequence.",
+ description: "Multiplier applied to the current frame to slow down or speed up the entire sequence",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/compositions/visual-docs-snippet.mdx b/content/docs/compositions/visual-docs-snippet.mdx
index 549be19c..7e56d8a1 100644
--- a/content/docs/compositions/visual-docs-snippet.mdx
+++ b/content/docs/compositions/visual-docs-snippet.mdx
@@ -1,6 +1,6 @@
---
title: Visual Docs Snippet
-description: Calm tutorial flow — virtual cursor arcs to a button, clicks, and a bounding box plus tooltip explain what just happened.
+description: Calm tutorial flow, virtual cursor arcs to a button, clicks, and a bounding box plus tooltip explain what just happened
---
<ComponentPreview name="visual-docs-snippet" />
@@ -40,15 +40,15 @@ export const RemotionRoot = () => (
<PropsTable
rows={[
- { name: "cursorStart", type: "{ x: number; y: number }", default: "{ x: 980, y: 560 }", description: "Where the cursor begins, in absolute frame coordinates." },
- { name: "cursorTarget", type: "{ x: number; y: number }", default: "{ x: 640, y: 360 }", description: "Where the cursor lands and clicks." },
+ { name: "cursorStart", type: "{ x: number; y: number }", default: "{ x: 980, y: 560 }", description: "Where the cursor begins, in absolute frame coordinates" },
+ { name: "cursorTarget", type: "{ x: number; y: number }", default: "{ x: 640, y: 360 }", description: "Where the cursor lands and clicks" },
{ name: "clickFrame", type: "number", default: "110", description: "Frame at which the click fires. All later anchors (bounding box, tooltip, settle) derive from this." },
- { name: "tooltipTitle", type: "string", default: '"Generate runs"', description: "Tooltip heading shown to the right of the bounding box." },
- { name: "tooltipBody", type: "string", default: '"Click to start a new generation…"', description: "Tooltip body copy." },
- { name: "buttonLabel", type: "string", default: '"Generate"', description: "Label inside the CTA button." },
- { name: "accent", type: "string", default: '"#FFB38E"', description: "Peach accent color used for the bounding box, tooltip border, and ripple." },
- { name: "background", type: "string", default: '"#141318"', description: "Stage background color." },
- { name: "speed", type: "number", default: "1", description: "Playback speed multiplier." },
- { name: "className", type: "string", description: "Optional className for the outer container." },
+ { name: "tooltipTitle", type: "string", default: '"Generate runs"', description: "Tooltip heading shown to the right of the bounding box" },
+ { name: "tooltipBody", type: "string", default: '"Click to start a new generation…"', description: "Tooltip body copy" },
+ { name: "buttonLabel", type: "string", default: '"Generate"', description: "Label inside the CTA button" },
+ { name: "accent", type: "string", default: '"#FFB38E"', description: "Peach accent color used for the bounding box, tooltip border, and ripple" },
+ { name: "background", type: "string", default: '"#141318"', description: "Stage background color" },
+ { name: "speed", type: "number", default: "1", description: "Playback speed multiplier" },
+ { name: "className", type: "string", description: "Optional className for the outer container" },
]}
/>
diff --git a/content/docs/environment/dynamic-grid.mdx b/content/docs/environment/dynamic-grid.mdx
index 5c43d1e0..eb69082e 100644
--- a/content/docs/environment/dynamic-grid.mdx
+++ b/content/docs/environment/dynamic-grid.mdx
@@ -1,6 +1,6 @@
---
title: Dynamic Grid
-description: Subtle moving grid background for tech and dev scenes.
+description: Subtle moving grid background for tech and dev scenes
---
<ComponentPreview name="dynamic-grid" />
@@ -46,19 +46,19 @@ export const RemotionRoot = () => (
name: "cellSize",
type: "number",
default: "40",
- description: "Grid cell size in pixels.",
+ description: "Grid cell size in pixels",
},
{
name: "lineColor",
type: "string",
default: "\"#27272a\"",
- description: "Grid line color.",
+ description: "Grid line color",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Base background color behind the grid.",
+ description: "Base background color behind the grid",
},
{
name: "speed",
@@ -70,12 +70,12 @@ export const RemotionRoot = () => (
name: "direction",
type: "\"diagonal\" | \"horizontal\" | \"vertical\"",
default: "\"diagonal\"",
- description: "Direction the grid drifts.",
+ description: "Direction the grid drifts",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/environment/index.mdx b/content/docs/environment/index.mdx
index ea8db258..65e611f4 100644
--- a/content/docs/environment/index.mdx
+++ b/content/docs/environment/index.mdx
@@ -1,6 +1,6 @@
---
title: Environment & Lighting
-description: Backgrounds, lighting, and atmosphere for your scenes.
+description: Backgrounds, lighting, and atmosphere for your scenes
---
The space behind your content. Animated gradients, grids, and lighting accents that turn flat compositions into rooms.
@@ -11,13 +11,13 @@ The space behind your content. Animated gradients, grids, and lighting accents t
items={[
{
name: "MeshGradientBg",
- description: "Living gradient where soft color blobs drift on noise-driven coordinates.",
+ description: "Living gradient where soft color blobs drift on noise-driven coordinates",
status: "stable",
href: "/docs/environment/mesh-gradient-bg",
},
{
name: "DynamicGrid",
- description: "Subtle moving grid or dot pattern background.",
+ description: "Subtle moving grid or dot pattern background",
status: "stable",
href: "/docs/environment/dynamic-grid",
},
@@ -30,7 +30,7 @@ The space behind your content. Animated gradients, grids, and lighting accents t
items={[
{
name: "SpotlightCard",
- description: "Cursor-tracked radial light that rims a card and lifts it from the dark.",
+ description: "Cursor-tracked radial light that rims a card and lifts it from the dark",
status: "stable",
href: "/docs/environment/spotlight-card",
},
diff --git a/content/docs/environment/mesh-gradient-bg.mdx b/content/docs/environment/mesh-gradient-bg.mdx
index ffde3232..f8ef0413 100644
--- a/content/docs/environment/mesh-gradient-bg.mdx
+++ b/content/docs/environment/mesh-gradient-bg.mdx
@@ -1,6 +1,6 @@
---
title: Mesh Gradient Background
-description: Living gradient with amorphous color blobs slowly drifting across the frame.
+description: Living gradient with amorphous color blobs slowly drifting across the frame
---
<ComponentPreview name="mesh-gradient-bg" />
@@ -62,12 +62,12 @@ export const RemotionRoot = () => (
name: "blur",
type: "number",
default: "80",
- description: "CSS blur radius (in pixels) applied to each blob.",
+ description: "CSS blur radius (in pixels) applied to each blob",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/environment/spotlight-card.mdx b/content/docs/environment/spotlight-card.mdx
index 1de9a855..f02a5e85 100644
--- a/content/docs/environment/spotlight-card.mdx
+++ b/content/docs/environment/spotlight-card.mdx
@@ -1,6 +1,6 @@
---
title: Spotlight Card
-description: A card with a moonlight-cool radial spotlight that follows a synthetic cursor and lights up its microborder.
+description: A card with a moonlight-cool radial spotlight that follows a synthetic cursor and lights up its microborder
---
<ComponentPreview name="spotlight-card" />
@@ -40,31 +40,31 @@ export const RemotionRoot = () => (
name: "title",
type: "string",
default: "\"Spotlight Card\"",
- description: "Heading shown when no children are provided.",
+ description: "Heading shown when no children are provided",
},
{
name: "body",
type: "string",
default: "\"Soft radial light follows the cursor, picking out the microborder.\"",
- description: "Body copy shown when no children are provided.",
+ description: "Body copy shown when no children are provided",
},
{
name: "cardWidth",
type: "number",
default: "520",
- description: "Card width in pixels.",
+ description: "Card width in pixels",
},
{
name: "cardHeight",
type: "number",
default: "320",
- description: "Card height in pixels.",
+ description: "Card height in pixels",
},
{
name: "glowSize",
type: "number",
default: "600",
- description: "Diameter (px) of the radial spotlight.",
+ description: "Diameter (px) of the radial spotlight",
},
{
name: "glowOpacity",
@@ -76,41 +76,41 @@ export const RemotionRoot = () => (
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Page background color around the card.",
+ description: "Page background color around the card",
},
{
name: "cardColor",
type: "string",
default: "\"#0a0a0a\"",
- description: "Card surface color.",
+ description: "Card surface color",
},
{
name: "textColor",
type: "string",
default: "\"#fafafa\"",
- description: "Heading color.",
+ description: "Heading color",
},
{
name: "mutedColor",
type: "string",
default: "\"#71717a\"",
- description: "Body copy color.",
+ description: "Body copy color",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
{
name: "children",
type: "ReactNode",
- description: "Override the default title/body slot with custom content.",
+ description: "Override the default title/body slot with custom content",
},
]}
/>
diff --git a/content/docs/getting-started/installation.mdx b/content/docs/getting-started/installation.mdx
index 1c0dc07c..25fa8b6a 100644
--- a/content/docs/getting-started/installation.mdx
+++ b/content/docs/getting-started/installation.mdx
@@ -1,6 +1,6 @@
---
title: Installation
-description: Add remocn to an existing Remotion project.
+description: Add remocn to an existing Remotion project
---
remocn assumes you already have Remotion installed. If you don't, run `npx create-video@latest` first.
@@ -13,7 +13,7 @@ If your project doesn't already have a `components.json`, run:
npx shadcn@latest init
```
-Pick the defaults — remocn components are framework-agnostic and only need the path aliases.
+Pick the defaults: remocn components are framework-agnostic and only need the path aliases.
## 2. Add a component
diff --git a/content/docs/getting-started/introduction.mdx b/content/docs/getting-started/introduction.mdx
index ced32c2c..dabfa9e5 100644
--- a/content/docs/getting-started/introduction.mdx
+++ b/content/docs/getting-started/introduction.mdx
@@ -1,15 +1,15 @@
---
title: Introduction
-description: What remocn is and who it's for.
+description: What remocn is and who it's for
---
-remocn is built for solo builders and small teams who need to ship product demo videos without rebuilding the same animation primitives every time. If you've used [shadcn/ui](https://ui.shadcn.com), you'll feel at home — the workflow is identical, just for video instead of UI.
+remocn is built for solo builders and small teams who need to ship product demo videos without rebuilding the same animation primitives every time. If you've used [shadcn/ui](https://ui.shadcn.com), you'll feel at home: the workflow is identical, just for video instead of UI.
## Why remocn
-- **Production-ready Remotion code.** Every component uses `useCurrentFrame()`, `interpolate()`, and `spring()` correctly. No `Math.random()` traps that break rendering.
-- **Own your code.** Components are copied into your project, not installed as a dependency. Tweak them however you like.
-- **Live previews.** Each component page mounts a real `@remotion/player` you can scrub frame-by-frame.
+- **Production-ready Remotion code:** every component uses `useCurrentFrame()`, `interpolate()`, and `spring()` correctly. No `Math.random()` traps that break rendering.
+- **Own your code:** components are copied into your project, not installed as a dependency. Tweak them however you like.
+- **Live previews:** each component page mounts a real `@remotion/player` you can scrub frame-by-frame.
## Prerequisites
@@ -21,5 +21,4 @@ npx create-video@latest
## What's next
-- [Installation](/docs/getting-started/installation) — add remocn to an existing Remotion project.
-- [CLI usage](/docs/getting-started/cli) — install components with the shadcn CLI.
+- [Installation](/docs/getting-started/installation): add remocn to an existing Remotion project
diff --git a/content/docs/primitives/bounding-box-selector.mdx b/content/docs/primitives/bounding-box-selector.mdx
index 9889f4fd..9dda809d 100644
--- a/content/docs/primitives/bounding-box-selector.mdx
+++ b/content/docs/primitives/bounding-box-selector.mdx
@@ -1,6 +1,6 @@
---
title: Bounding Box Selector
-description: Figma-style selection rectangle appears around any element.
+description: Figma-style selection rectangle appears around any element
---
<ComponentPreview name="bounding-box-selector" />
@@ -45,36 +45,36 @@ export const RemotionRoot = () => (
name: "borderColor",
type: "string",
default: '"#0ea5e9"',
- description: "Color of the selection border.",
+ description: "Color of the selection border",
},
{
name: "handleColor",
type: "string",
default: '"#0ea5e9"',
- description: "Stroke color of the corner/edge handles.",
+ description: "Stroke color of the corner/edge handles",
},
{
name: "borderWidth",
type: "number",
default: "2",
- description: "Border width in pixels.",
+ description: "Border width in pixels",
},
{
name: "appearAt",
type: "number",
default: "15",
- description: "Frame at which the selection box appears.",
+ description: "Frame at which the selection box appears",
},
{
name: "background",
type: "string",
default: '"#fafafa"',
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/primitives/brush-stroke-simulator.mdx b/content/docs/primitives/brush-stroke-simulator.mdx
index 4fb2132f..66b6813c 100644
--- a/content/docs/primitives/brush-stroke-simulator.mdx
+++ b/content/docs/primitives/brush-stroke-simulator.mdx
@@ -1,6 +1,6 @@
---
title: Brush Stroke Simulator
-description: A simulated fingertip drags a blur brush across an image, revealing a pixelated overlay along its trail.
+description: A simulated fingertip drags a blur brush across an image, revealing a pixelated overlay along its trail
---
<ComponentPreview name="brush-stroke-simulator" />
@@ -43,37 +43,37 @@ export const RemotionRoot = () => (
name: "brushSize",
type: "number",
default: "70",
- description: "Diameter of the cursor and width of the reveal stroke in pixels.",
+ description: "Diameter of the cursor and width of the reveal stroke in pixels",
},
{
name: "cursorColor",
type: "string",
default: "\"rgba(255,255,255,0.45)\"",
- description: "Fill color of the semi-transparent fingertip circle.",
+ description: "Fill color of the semi-transparent fingertip circle",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Page background behind the simulated portrait.",
+ description: "Page background behind the simulated portrait",
},
{
name: "baseColorA",
type: "string",
default: "\"#f4a261\"",
- description: "Highlight tint of the simulated portrait beneath the overlay.",
+ description: "Highlight tint of the simulated portrait beneath the overlay",
},
{
name: "baseColorB",
type: "string",
default: "\"#e76f51\"",
- description: "Shadow tint of the simulated portrait beneath the overlay.",
+ description: "Shadow tint of the simulated portrait beneath the overlay",
},
{
name: "overlayColor",
type: "string",
default: "\"#1f1f23\"",
- description: "Base color of the pixelated overlay that the brush reveals.",
+ description: "Base color of the pixelated overlay that the brush reveals",
},
{
name: "startFrame",
@@ -85,18 +85,18 @@ export const RemotionRoot = () => (
name: "sweepDuration",
type: "number",
default: "150",
- description: "How many frames the brush takes to traverse the full waypoint chain.",
+ description: "How many frames the brush takes to traverse the full waypoint chain",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier applied to the internal frame counter.",
+ description: "Playback speed multiplier applied to the internal frame counter",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/primitives/cursor-flow.mdx b/content/docs/primitives/cursor-flow.mdx
index a0af2d36..d68d17a7 100644
--- a/content/docs/primitives/cursor-flow.mdx
+++ b/content/docs/primitives/cursor-flow.mdx
@@ -1,6 +1,6 @@
---
title: Cursor Flow
-description: A realistic mouse that arcs along cubic Bezier paths, pauses, and clicks targets that dip in response.
+description: A realistic mouse that arcs along cubic Bezier paths, pauses, and clicks targets that dip in response
---
<ComponentPreview name="cursor-flow" />
@@ -52,42 +52,42 @@ export const RemotionRoot = () => (
name: "cursorColor",
type: "string",
default: "\"#fafafa\"",
- description: "Cursor SVG fill color.",
+ description: "Cursor SVG fill color",
},
{
name: "cursorSize",
type: "number",
default: "28",
- description: "Cursor SVG side length in pixels.",
+ description: "Cursor SVG side length in pixels",
},
{
name: "segmentDuration",
type: "number",
default: "36",
- description: "Frames spent traversing one segment between two waypoints.",
+ description: "Frames spent traversing one segment between two waypoints",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Page background color.",
+ description: "Page background color",
},
{
name: "showTargets",
type: "boolean",
default: "true",
- description: "Render the click target chips at clickable waypoints.",
+ description: "Render the click target chips at clickable waypoints",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
@@ -137,18 +137,18 @@ import { SimulatedCursor } from "@/components/remocn/simulated-cursor";
name: "size",
type: "number",
default: "32",
- description: "Cursor size in pixels (SVG width and height).",
+ description: "Cursor size in pixels (SVG width and height)",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Background color of the frame the cursor lives in.",
+ description: "Background color of the frame the cursor lives in",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/primitives/index.mdx b/content/docs/primitives/index.mdx
index b9bc4c14..9c59f13d 100644
--- a/content/docs/primitives/index.mdx
+++ b/content/docs/primitives/index.mdx
@@ -1,9 +1,9 @@
---
title: Core Primitives
-description: Foundational micro-interactions and reusable building blocks.
+description: Foundational micro-interactions and reusable building blocks
---
-The smallest reusable units in remocn — pop-ins, pulses, cursors, and notifications. Drop them into any scene whenever you need a focused moment of motion.
+The smallest reusable units in remocn: pop-ins, pulses, cursors, and notifications. Drop them into any scene whenever you need a focused moment of motion.
## Animations
@@ -11,19 +11,19 @@ The smallest reusable units in remocn — pop-ins, pulses, cursors, and notifica
items={[
{
name: "SpringPopIn",
- description: "Elastic scale pop with configurable overshoot.",
+ description: "Elastic scale pop with configurable overshoot",
status: "stable",
href: "/docs/primitives/spring-pop-in",
},
{
name: "PulsingIndicator",
- description: "Continuous sine-driven pulse for loading or activity states.",
+ description: "Continuous sine-driven pulse for loading or activity states",
status: "stable",
href: "/docs/primitives/pulsing-indicator",
},
{
name: "SuccessConfetti",
- description: "Deterministic particle burst from a chosen origin point.",
+ description: "Deterministic particle burst from a chosen origin point",
status: "stable",
href: "/docs/primitives/success-confetti",
},
@@ -42,13 +42,13 @@ The smallest reusable units in remocn — pop-ins, pulses, cursors, and notifica
},
{
name: "BoundingBoxSelector",
- description: "Figma-style selection rectangle that snaps around a target.",
+ description: "Figma-style selection rectangle that snaps around a target",
status: "stable",
href: "/docs/primitives/bounding-box-selector",
},
{
name: "ToastNotification",
- description: "System toast that springs in, holds, and slides away.",
+ description: "System toast that springs in, holds, and slides away",
status: "stable",
href: "/docs/primitives/toast-notification",
},
diff --git a/content/docs/primitives/pulsing-indicator.mdx b/content/docs/primitives/pulsing-indicator.mdx
index 5dc9c52c..42b7cfe6 100644
--- a/content/docs/primitives/pulsing-indicator.mdx
+++ b/content/docs/primitives/pulsing-indicator.mdx
@@ -1,6 +1,6 @@
---
title: Pulsing Indicator
-description: Continuous pulsing dot for loading and "live" states.
+description: Continuous pulsing dot for loading and "live" states
---
<ComponentPreview name="pulsing-indicator" />
@@ -40,7 +40,7 @@ export const RemotionRoot = () => (
name: "color",
type: "string",
default: "\"#22c55e\"",
- description: "Dot and ring color.",
+ description: "Dot and ring color",
},
{
name: "size",
@@ -58,12 +58,12 @@ export const RemotionRoot = () => (
name: "background",
type: "string",
default: "\"white\"",
- description: "Background color of the surrounding container.",
+ description: "Background color of the surrounding container",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/primitives/spring-pop-in.mdx b/content/docs/primitives/spring-pop-in.mdx
index 02a97ed5..0325226c 100644
--- a/content/docs/primitives/spring-pop-in.mdx
+++ b/content/docs/primitives/spring-pop-in.mdx
@@ -1,6 +1,6 @@
---
title: Spring Pop In
-description: Elastic scale-in wrapper for any element.
+description: Elastic scale-in wrapper for any element
---
<ComponentPreview name="spring-pop-in" />
@@ -44,7 +44,7 @@ export const RemotionRoot = () => (
name: "children",
type: "ReactNode",
required: true,
- description: "Element(s) to animate.",
+ description: "Element(s) to animate",
},
{
name: "damping",
@@ -56,24 +56,24 @@ export const RemotionRoot = () => (
name: "mass",
type: "number",
default: "1",
- description: "Spring mass.",
+ description: "Spring mass",
},
{
name: "stiffness",
type: "number",
default: "100",
- description: "Spring stiffness.",
+ description: "Spring stiffness",
},
{
name: "delayInFrames",
type: "number",
default: "0",
- description: "Delay before the spring starts, in frames.",
+ description: "Delay before the spring starts, in frames",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/primitives/success-confetti.mdx b/content/docs/primitives/success-confetti.mdx
index 11185d8e..99fe6fbb 100644
--- a/content/docs/primitives/success-confetti.mdx
+++ b/content/docs/primitives/success-confetti.mdx
@@ -1,6 +1,6 @@
---
title: Success Confetti
-description: Deterministic confetti burst from a focal point with optional headline.
+description: Deterministic confetti burst from a focal point with optional headline
---
<ComponentPreview name="success-confetti" />
@@ -44,37 +44,37 @@ export const RemotionRoot = () => (
name: "count",
type: "number",
default: "60",
- description: "Number of confetti particles.",
+ description: "Number of confetti particles",
},
{
name: "colors",
type: "string[]",
default: "[\"#ff5e3a\",\"#22c55e\",\"#0ea5e9\",\"#facc15\",\"#a855f7\"]",
- description: "Pool of colors that particles are randomly drawn from.",
+ description: "Pool of colors that particles are randomly drawn from",
},
{
name: "originX",
type: "number",
default: "0.5",
- description: "Horizontal burst origin as a fraction of the frame width (0..1).",
+ description: "Horizontal burst origin as a fraction of the frame width (0..1)",
},
{
name: "originY",
type: "number",
default: "0.5",
- description: "Vertical burst origin as a fraction of the frame height (0..1).",
+ description: "Vertical burst origin as a fraction of the frame height (0..1)",
},
{
name: "gravity",
type: "number",
default: "0.4",
- description: "Downward acceleration applied per frame squared.",
+ description: "Downward acceleration applied per frame squared",
},
{
name: "velocity",
type: "number",
default: "12",
- description: "Base outward speed for each particle in pixels per frame.",
+ description: "Base outward speed for each particle in pixels per frame",
},
{
name: "text",
@@ -86,13 +86,13 @@ export const RemotionRoot = () => (
name: "textColor",
type: "string",
default: "\"#171717\"",
- description: "Color of the headline.",
+ description: "Color of the headline",
},
{
name: "background",
type: "string",
default: "\"#fafafa\"",
- description: "Frame background color.",
+ description: "Frame background color",
},
{
name: "seed",
@@ -103,7 +103,7 @@ export const RemotionRoot = () => (
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/primitives/toast-notification.mdx b/content/docs/primitives/toast-notification.mdx
index aa4cc106..ddef053c 100644
--- a/content/docs/primitives/toast-notification.mdx
+++ b/content/docs/primitives/toast-notification.mdx
@@ -1,6 +1,6 @@
---
title: Toast Notification
-description: System-style toast that pops in, holds, then slides out.
+description: System-style toast that pops in, holds, then slides out
---
<ComponentPreview name="toast-notification" />
@@ -44,48 +44,48 @@ export const RemotionRoot = () => (
name: "title",
type: "string",
default: "\"Deployment successful\"",
- description: "Bold headline shown at the top of the toast.",
+ description: "Bold headline shown at the top of the toast",
},
{
name: "message",
type: "string",
default: "\"Your changes are live at remocn.dev\"",
- description: "Secondary message shown below the title.",
+ description: "Secondary message shown below the title",
},
{
name: "variant",
type: "\"success\" | \"error\" | \"info\" | \"warning\"",
default: "\"success\"",
- description: "Controls the inline icon and accent color.",
+ description: "Controls the inline icon and accent color",
},
{
name: "background",
type: "string",
default: "\"#fafafa\"",
- description: "Frame background color.",
+ description: "Frame background color",
},
{
name: "cardColor",
type: "string",
default: "\"white\"",
- description: "Toast card background color.",
+ description: "Toast card background color",
},
{
name: "textColor",
type: "string",
default: "\"#171717\"",
- description: "Color of the toast title.",
+ description: "Color of the toast title",
},
{
name: "mutedColor",
type: "string",
default: "\"#71717a\"",
- description: "Color of the toast message.",
+ description: "Color of the toast message",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the toast card.",
+ description: "Optional className passed to the toast card",
},
]}
/>
diff --git a/content/docs/transitions/chromatic-aberration-wipe.mdx b/content/docs/transitions/chromatic-aberration-wipe.mdx
index 3cd4b5e0..5444bcac 100644
--- a/content/docs/transitions/chromatic-aberration-wipe.mdx
+++ b/content/docs/transitions/chromatic-aberration-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Chromatic Aberration Wipe
-description: An ultra-fast slide transition with an RGB glitch on the peak frames.
+description: An ultra-fast slide transition with an RGB glitch on the peak frames
---
<ComponentPreview name="chromatic-aberration-wipe" />
@@ -51,34 +51,34 @@ export const RemotionRoot = () => (
name: "direction",
type: '"left" | "right"',
default: '"left"',
- description: "Direction the outgoing scene slides toward.",
+ description: "Direction the outgoing scene slides toward",
},
{
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.4",
- description: "Frame at which the wipe begins.",
+ description: "Frame at which the wipe begins",
},
{
name: "transitionDuration",
type: "number",
default: "7",
- description: "Length of the wipe in frames. Keep it short (5–8) for the glitch to land.",
+ description: "Length of the wipe in frames. Keep it short (5-8) for the glitch to land.",
},
{
name: "aberrationOffset",
type: "number",
default: "8",
- description: "Horizontal offset in pixels for the red and cyan drop shadows during the peak frames.",
+ description: "Horizontal offset in pixels for the red and cyan drop shadows during the peak frames",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
<Warning title="Less is more">
- The chromatic aberration should only flash for 3–5 frames at peak speed. Any longer and the viewer starts consciously reading the red and cyan fringes — which kills the illusion of raw velocity. Trust the subconscious; pull the filter the moment the slide decelerates.
+ The chromatic aberration should only flash for 3-5 frames at peak speed. Any longer and the viewer starts consciously reading the red and cyan fringes, which kills the illusion of raw velocity. Trust the subconscious; pull the filter the moment the slide decelerates.
</Warning>
diff --git a/content/docs/transitions/device-mockup-zoom.mdx b/content/docs/transitions/device-mockup-zoom.mdx
index b5389a45..fe024781 100644
--- a/content/docs/transitions/device-mockup-zoom.mdx
+++ b/content/docs/transitions/device-mockup-zoom.mdx
@@ -1,6 +1,6 @@
---
title: Device Mockup Zoom
-description: Pull back from a UI to reveal it inside a device frame.
+description: Pull back from a UI to reveal it inside a device frame
---
<ComponentPreview name="device-mockup-zoom" />
@@ -45,30 +45,30 @@ export const RemotionRoot = () => (
name: "device",
type: '"laptop" | "phone"',
default: '"laptop"',
- description: "Which inline mockup to render.",
+ description: "Which inline mockup to render",
},
{
name: "frameColor",
type: "string",
default: '"#1f1f1f"',
- description: "Color of the device chrome.",
+ description: "Color of the device chrome",
},
{
name: "screenColor",
type: "string",
default: '"#0a0a0a"',
- description: "Background color shown behind the screen content.",
+ description: "Background color shown behind the screen content",
},
{
name: "background",
type: "string",
default: '"#fafafa"',
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/directional-wipe.mdx b/content/docs/transitions/directional-wipe.mdx
index 8b163916..009fda39 100644
--- a/content/docs/transitions/directional-wipe.mdx
+++ b/content/docs/transitions/directional-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Directional Wipe
-description: Slide one scene in while pushing the other out.
+description: Slide one scene in while pushing the other out
---
<ComponentPreview name="directional-wipe" />
@@ -51,24 +51,24 @@ export const RemotionRoot = () => (
name: "direction",
type: '"left" | "right" | "up" | "down"',
default: '"left"',
- description: "Direction the outgoing scene slides toward.",
+ description: "Direction the outgoing scene slides toward",
},
{
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.4",
- description: "Frame at which the wipe begins.",
+ description: "Frame at which the wipe begins",
},
{
name: "transitionDuration",
type: "number",
default: "20",
- description: "Length of the wipe in frames.",
+ description: "Length of the wipe in frames",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/frosted-glass-wipe.mdx b/content/docs/transitions/frosted-glass-wipe.mdx
index eeac5ea9..dbb0c558 100644
--- a/content/docs/transitions/frosted-glass-wipe.mdx
+++ b/content/docs/transitions/frosted-glass-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Frosted Glass Wipe
-description: Elegant scene transition through a sliding pane of frosted glass.
+description: Elegant scene transition through a sliding pane of frosted glass
---
<ComponentPreview name="frosted-glass-wipe" />
@@ -51,24 +51,24 @@ export const RemotionRoot = () => (
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.4",
- description: "Frame at which the wipe begins.",
+ description: "Frame at which the wipe begins",
},
{
name: "transitionDuration",
type: "number",
default: "30",
- description: "Length of the wipe in frames.",
+ description: "Length of the wipe in frames",
},
{
name: "glassBlur",
type: "number",
default: "24",
- description: "Backdrop blur radius of the glass pane in pixels.",
+ description: "Backdrop blur radius of the glass pane in pixels",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/grid-pixelate-wipe.mdx b/content/docs/transitions/grid-pixelate-wipe.mdx
index e91ed56e..beba3bce 100644
--- a/content/docs/transitions/grid-pixelate-wipe.mdx
+++ b/content/docs/transitions/grid-pixelate-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Grid Pixelate Wipe
-description: Dissolve from one scene to the next through a deterministic grid of mask cells.
+description: Dissolve from one scene to the next through a deterministic grid of mask cells
---
<ComponentPreview name="grid-pixelate-wipe" />
@@ -51,42 +51,42 @@ export const RemotionRoot = () => (
name: "cols",
type: "number",
default: "12",
- description: "Number of mask grid columns.",
+ description: "Number of mask grid columns",
},
{
name: "rows",
type: "number",
default: "7",
- description: "Number of mask grid rows.",
+ description: "Number of mask grid rows",
},
{
name: "pattern",
type: '"wave" | "diagonal" | "spiral"',
default: '"wave"',
- description: "Deterministic function used to compute per-cell delay.",
+ description: "Deterministic function used to compute per-cell delay",
},
{
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.4",
- description: "Frame at which the dissolve begins.",
+ description: "Frame at which the dissolve begins",
},
{
name: "transitionDuration",
type: "number",
default: "30",
- description: "Total length of the dissolve in frames.",
+ description: "Total length of the dissolve in frames",
},
{
name: "cellFadeFrames",
type: "number",
default: "4",
- description: "How many frames a single cell takes to fade out.",
+ description: "How many frames a single cell takes to fade out",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/image-expand-to-fullscreen.mdx b/content/docs/transitions/image-expand-to-fullscreen.mdx
index a13f12e9..975c87a6 100644
--- a/content/docs/transitions/image-expand-to-fullscreen.mdx
+++ b/content/docs/transitions/image-expand-to-fullscreen.mdx
@@ -1,6 +1,6 @@
---
title: Image Expand To Fullscreen
-description: A thumbnail in a feed post lifts off the card and morphs seamlessly into a fullscreen editor, with toolbars sliding in to meet it.
+description: A thumbnail in a feed post lifts off the card and morphs seamlessly into a fullscreen editor, with toolbars sliding in to meet it
---
<ComponentPreview name="image-expand-to-fullscreen" />
@@ -43,88 +43,88 @@ export const RemotionRoot = () => (
{
name: "from",
type: "{ top, left, width, height }",
- description: "Source rect of the thumbnail inside the feed post.",
+ description: "Source rect of the thumbnail inside the feed post",
},
{
name: "to",
type: "{ top, left, width, height }",
- description: "Target rect of the image inside the fullscreen editor.",
+ description: "Target rect of the image inside the fullscreen editor",
},
{
name: "borderRadiusFrom",
type: "number",
default: "12",
- description: "Border radius of the thumbnail in pixels.",
+ description: "Border radius of the thumbnail in pixels",
},
{
name: "borderRadiusTo",
type: "number",
default: "16",
- description: "Border radius of the editor image in pixels.",
+ description: "Border radius of the editor image in pixels",
},
{
name: "morphAt",
type: "number",
default: "30",
- description: "Frame at which the shared-element morph fires.",
+ description: "Frame at which the shared-element morph fires",
},
{
name: "imageColorA",
type: "string",
default: "\"#ff6b6b\"",
- description: "First stop of the faked image gradient.",
+ description: "First stop of the faked image gradient",
},
{
name: "imageColorB",
type: "string",
default: "\"#845ec2\"",
- description: "Second stop of the faked image gradient.",
+ description: "Second stop of the faked image gradient",
},
{
name: "imageColorC",
type: "string",
default: "\"#4d8dff\"",
- description: "Third stop of the faked image gradient.",
+ description: "Third stop of the faked image gradient",
},
{
name: "feedBackground",
type: "string",
default: "\"#f4f4f5\"",
- description: "Page background color of the feed (before the morph).",
+ description: "Page background color of the feed (before the morph)",
},
{
name: "editorBackground",
type: "string",
default: "\"#0a0a0a\"",
- description: "Canvas background color of the editor (after the morph).",
+ description: "Canvas background color of the editor (after the morph)",
},
{
name: "accent",
type: "string",
default: "\"#fafafa\"",
- description: "Accent color used for toolbar text and the active tool chip.",
+ description: "Accent color used for toolbar text and the active tool chip",
},
{
name: "postAuthor",
type: "string",
default: "\"Maya Larsson\"",
- description: "Author name shown on the feed post.",
+ description: "Author name shown on the feed post",
},
{
name: "postBody",
type: "string",
- description: "Caption shown on the feed post above the thumbnail.",
+ description: "Caption shown on the feed post above the thumbnail",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/transitions/index.mdx b/content/docs/transitions/index.mdx
index 61eb4b8a..9fe227e1 100644
--- a/content/docs/transitions/index.mdx
+++ b/content/docs/transitions/index.mdx
@@ -1,6 +1,6 @@
---
title: Transitions
-description: Scene transitions, camera moves, and stylized wipes.
+description: Scene transitions, camera moves, and stylized wipes
---
Wipes, slides, zooms, and camera moves between scenes. Group your scenes inside `<Sequence>` and let these handle the seam.
@@ -11,19 +11,19 @@ Wipes, slides, zooms, and camera moves between scenes. Group your scenes inside
items={[
{
name: "ZoomThroughTransition",
- description: "Aggressive scale-in 'through' an element to the next scene.",
+ description: "Aggressive scale-in 'through' an element to the next scene",
status: "stable",
href: "/docs/transitions/zoom-through-transition",
},
{
name: "DeviceMockupZoom",
- description: "Pull back from a UI to reveal it inside a phone or laptop frame.",
+ description: "Pull back from a UI to reveal it inside a phone or laptop frame",
status: "stable",
href: "/docs/transitions/device-mockup-zoom",
},
{
name: "MorphingModal",
- description: "Card lifts off a grid and expands into a full-screen modal.",
+ description: "Card lifts off a grid and expands into a full-screen modal",
status: "stable",
href: "/docs/transitions/morphing-modal",
},
@@ -36,25 +36,25 @@ Wipes, slides, zooms, and camera moves between scenes. Group your scenes inside
items={[
{
name: "DirectionalWipe",
- description: "Slide one scene in while pushing the other out.",
+ description: "Slide one scene in while pushing the other out",
status: "stable",
href: "/docs/transitions/directional-wipe",
},
{
name: "SpatialPush",
- description: "A new scene physically presses the old one back into the frame.",
+ description: "A new scene physically presses the old one back into the frame",
status: "stable",
href: "/docs/transitions/spatial-push",
},
{
name: "FrostedGlassWipe",
- description: "Elegant scene transition through a sliding pane of frosted glass.",
+ description: "Elegant scene transition through a sliding pane of frosted glass",
status: "stable",
href: "/docs/transitions/frosted-glass-wipe",
},
{
name: "KineticTypeMask",
- description: "Use giant typography as a window into the next scene.",
+ description: "Use giant typography as a window into the next scene",
status: "stable",
href: "/docs/transitions/kinetic-type-mask",
},
@@ -67,13 +67,13 @@ Wipes, slides, zooms, and camera moves between scenes. Group your scenes inside
items={[
{
name: "GridPixelateWipe",
- description: "Dissolve from one scene to the next through a deterministic grid of mask cells.",
+ description: "Dissolve from one scene to the next through a deterministic grid of mask cells",
status: "stable",
href: "/docs/transitions/grid-pixelate-wipe",
},
{
name: "ChromaticAberrationWipe",
- description: "An ultra-fast slide transition with an RGB glitch on the peak frames.",
+ description: "An ultra-fast slide transition with an RGB glitch on the peak frames",
status: "stable",
href: "/docs/transitions/chromatic-aberration-wipe",
},
diff --git a/content/docs/transitions/kinetic-type-mask.mdx b/content/docs/transitions/kinetic-type-mask.mdx
index efb9a7b0..555e9660 100644
--- a/content/docs/transitions/kinetic-type-mask.mdx
+++ b/content/docs/transitions/kinetic-type-mask.mdx
@@ -1,6 +1,6 @@
---
title: Kinetic Type Mask
-description: Use giant typography as a window into the next scene.
+description: Use giant typography as a window into the next scene
---
<ComponentPreview name="kinetic-type-mask" />
@@ -51,25 +51,25 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
default: '"NEXT"',
- description: "The headline used as a clipping mask.",
+ description: "The headline used as a clipping mask",
},
{
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.3",
- description: "Frame at which the hold (pre-zoom) begins.",
+ description: "Frame at which the hold (pre-zoom) begins",
},
{
name: "holdFrames",
type: "number",
default: "12",
- description: "How long the text sits at rest before the zoom kicks in.",
+ description: "How long the text sits at rest before the zoom kicks in",
},
{
name: "transitionDuration",
type: "number",
default: "24",
- description: "Length of the exponential scale-up in frames.",
+ description: "Length of the exponential scale-up in frames",
},
{
name: "maxScale",
@@ -80,7 +80,7 @@ export const RemotionRoot = () => (
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/morphing-modal.mdx b/content/docs/transitions/morphing-modal.mdx
index 82bdc481..c915fee8 100644
--- a/content/docs/transitions/morphing-modal.mdx
+++ b/content/docs/transitions/morphing-modal.mdx
@@ -1,6 +1,6 @@
---
title: Morphing Modal
-description: A bento card lifts off the grid and blooms into a full-screen modal driven by a single heavy spring.
+description: A bento card lifts off the grid and blooms into a full-screen modal driven by a single heavy spring
---
<ComponentPreview name="morphing-modal" />
@@ -43,7 +43,7 @@ export const RemotionRoot = () => (
{
name: "from",
type: "{ top, left, width, height }",
- description: "Source rect of the card before it blooms.",
+ description: "Source rect of the card before it blooms",
},
{
name: "to",
@@ -54,87 +54,87 @@ export const RemotionRoot = () => (
name: "borderRadiusFrom",
type: "number",
default: "24",
- description: "Border radius of the source card in pixels.",
+ description: "Border radius of the source card in pixels",
},
{
name: "borderRadiusTo",
type: "number",
default: "0",
- description: "Border radius of the modal in pixels.",
+ description: "Border radius of the modal in pixels",
},
{
name: "morphAt",
type: "number",
default: "30",
- description: "Frame at which the morph spring fires.",
+ description: "Frame at which the morph spring fires",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Page background color.",
+ description: "Page background color",
},
{
name: "cardColor",
type: "string",
default: "\"#0a0a0a\"",
- description: "Card / modal surface color.",
+ description: "Card / modal surface color",
},
{
name: "textColor",
type: "string",
default: "\"#fafafa\"",
- description: "Heading color in source and modal.",
+ description: "Heading color in source and modal",
},
{
name: "mutedColor",
type: "string",
default: "\"#71717a\"",
- description: "Body copy color.",
+ description: "Body copy color",
},
{
name: "sourceTitle",
type: "string",
default: "\"Compose video\"",
- description: "Heading shown on the source card.",
+ description: "Heading shown on the source card",
},
{
name: "sourceBody",
type: "string",
default: "\"Click to start a new project\"",
- description: "Body copy shown on the source card.",
+ description: "Body copy shown on the source card",
},
{
name: "modalTitle",
type: "string",
default: "\"New project\"",
- description: "Heading shown after the morph completes.",
+ description: "Heading shown after the morph completes",
},
{
name: "modalBody",
type: "string",
- description: "Body copy shown after the morph completes.",
+ description: "Body copy shown after the morph completes",
},
{
name: "source",
type: "ReactNode",
- description: "Override the default source card content.",
+ description: "Override the default source card content",
},
{
name: "modal",
type: "ReactNode",
- description: "Override the default modal content.",
+ description: "Override the default modal content",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/transitions/spatial-push.mdx b/content/docs/transitions/spatial-push.mdx
index 0e4508e9..6c7e5474 100644
--- a/content/docs/transitions/spatial-push.mdx
+++ b/content/docs/transitions/spatial-push.mdx
@@ -1,6 +1,6 @@
---
title: Spatial Push
-description: A new scene physically presses the old one back into the frame.
+description: A new scene physically presses the old one back into the frame
---
<ComponentPreview name="spatial-push" />
@@ -51,24 +51,24 @@ export const RemotionRoot = () => (
name: "direction",
type: '"up" | "down" | "left" | "right"',
default: '"up"',
- description: "Direction the incoming scene enters from.",
+ description: "Direction the incoming scene enters from",
},
{
name: "transitionStart",
type: "number",
default: "durationInFrames * 0.4",
- description: "Frame at which the push begins.",
+ description: "Frame at which the push begins",
},
{
name: "transitionDuration",
type: "number",
default: "30",
- description: "Easing window for Scene A's retreat, in frames.",
+ description: "Easing window for Scene A's retreat, in frames",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/transitions/swipe-transition-wipe.mdx b/content/docs/transitions/swipe-transition-wipe.mdx
index d4e72e21..c0789f86 100644
--- a/content/docs/transitions/swipe-transition-wipe.mdx
+++ b/content/docs/transitions/swipe-transition-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Swipe Transition Wipe
-description: A mobile-style swipe transition where the outgoing scene flicks off-screen and the new one slides in beside it, with a parallax background and a darkening trail.
+description: A mobile-style swipe transition where the outgoing scene flicks off-screen and the new one slides in beside it, with a parallax background and a darkening trail
---
<ComponentPreview name="swipe-transition-wipe" />
@@ -44,89 +44,89 @@ export const RemotionRoot = () => (
{
name: "sceneA",
type: "ReactNode",
- description: "Override the first (outgoing) scene's content.",
+ description: "Override the first (outgoing) scene's content",
},
{
name: "sceneB",
type: "ReactNode",
- description: "Override the second (incoming) scene's content.",
+ description: "Override the second (incoming) scene's content",
},
{
name: "labelA",
type: "string",
default: "\"First\"",
- description: "Label rendered on the default scene A gradient.",
+ description: "Label rendered on the default scene A gradient",
},
{
name: "labelB",
type: "string",
default: "\"Second\"",
- description: "Label rendered on the default scene B gradient.",
+ description: "Label rendered on the default scene B gradient",
},
{
name: "colorA1",
type: "string",
default: "\"#0ea5e9\"",
- description: "First gradient stop for scene A.",
+ description: "First gradient stop for scene A",
},
{
name: "colorA2",
type: "string",
default: "\"#1e3a8a\"",
- description: "Second gradient stop for scene A.",
+ description: "Second gradient stop for scene A",
},
{
name: "colorB1",
type: "string",
default: "\"#f97316\"",
- description: "First gradient stop for scene B.",
+ description: "First gradient stop for scene B",
},
{
name: "colorB2",
type: "string",
default: "\"#9333ea\"",
- description: "Second gradient stop for scene B.",
+ description: "Second gradient stop for scene B",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Stage background behind the parallax layer.",
+ description: "Stage background behind the parallax layer",
},
{
name: "direction",
type: "\"left\" | \"right\"",
default: "\"left\"",
- description: "Which way the outgoing scene flicks off the screen.",
+ description: "Which way the outgoing scene flicks off the screen",
},
{
name: "swipeAt",
type: "number",
default: "30",
- description: "Frame at which the swipe spring fires.",
+ description: "Frame at which the swipe spring fires",
},
{
name: "parallaxFactor",
type: "number",
default: "0.6",
- description: "How much slower the background moves vs the foreground (0 = locked, 1 = matched).",
+ description: "How much slower the background moves vs the foreground (0 = locked, 1 = matched)",
},
{
name: "dimStrength",
type: "number",
default: "0.4",
- description: "Maximum opacity of the darkening overlay applied to the outgoing scene.",
+ description: "Maximum opacity of the darkening overlay applied to the outgoing scene",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/transitions/zoom-through-transition.mdx b/content/docs/transitions/zoom-through-transition.mdx
index 4913df4f..24b639fa 100644
--- a/content/docs/transitions/zoom-through-transition.mdx
+++ b/content/docs/transitions/zoom-through-transition.mdx
@@ -1,6 +1,6 @@
---
title: Zoom Through Transition
-description: Aggressively scale into the center of an element to fly through it.
+description: Aggressively scale into the center of an element to fly through it
---
<ComponentPreview name="zoom-through-transition" />
@@ -45,24 +45,24 @@ export const RemotionRoot = () => (
name: "targetScale",
type: "number",
default: "20",
- description: "Final scale value at the end of the duration.",
+ description: "Final scale value at the end of the duration",
},
{
name: "transformOrigin",
type: "string",
default: '"center center"',
- description: "CSS transform-origin for the zoom point.",
+ description: "CSS transform-origin for the zoom point",
},
{
name: "background",
type: "string",
default: '"white"',
- description: "Background color visible during the zoom.",
+ description: "Background color visible during the zoom",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/typography/blur-reveal.mdx b/content/docs/typography/blur-reveal.mdx
index fda5f823..1d0cfda5 100644
--- a/content/docs/typography/blur-reveal.mdx
+++ b/content/docs/typography/blur-reveal.mdx
@@ -1,6 +1,6 @@
---
title: Blur Reveal
-description: Text fades in from a heavy blur into sharp focus.
+description: Text fades in from a heavy blur into sharp focus
---
<ComponentPreview name="blur-reveal" />
@@ -40,7 +40,7 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The text to reveal.",
+ description: "The text to reveal",
},
{
name: "blur",
@@ -52,24 +52,24 @@ export const RemotionRoot = () => (
name: "fontSize",
type: "number",
default: "48",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color (any valid CSS color).",
+ description: "Text color (any valid CSS color)",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/typography/index.mdx b/content/docs/typography/index.mdx
index 488c083d..dbc047df 100644
--- a/content/docs/typography/index.mdx
+++ b/content/docs/typography/index.mdx
@@ -1,6 +1,6 @@
---
title: Typography
-description: Text effects, reveals, and kinetic type for Remotion.
+description: Text effects, reveals, and kinetic type for Remotion
---
Every way text can move, fade, glitch, or stretch across the screen. From quiet word-by-word reveals to full-bleed marquees and RGB glitches.
@@ -11,25 +11,25 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
items={[
{
name: "BlurReveal",
- description: "Text fades in from a heavy blur into sharp focus.",
+ description: "Text fades in from a heavy blur into sharp focus",
status: "stable",
href: "/docs/typography/blur-reveal",
},
{
name: "StaggeredFadeUp",
- description: "Words rise from below with a soft cascading delay.",
+ description: "Words rise from below with a soft cascading delay",
status: "stable",
href: "/docs/typography/staggered-fade-up",
},
{
name: "MaskedSlideReveal",
- description: "Lines grow out from behind an invisible horizontal mask.",
+ description: "Lines grow out from behind an invisible horizontal mask",
status: "stable",
href: "/docs/typography/masked-slide-reveal",
},
{
name: "TrackingIn",
- description: "Letter-spacing collapses from wide to normal with a spring snap.",
+ description: "Letter-spacing collapses from wide to normal with a spring snap",
status: "stable",
href: "/docs/typography/tracking-in",
},
@@ -42,19 +42,19 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
items={[
{
name: "InlineHighlight",
- description: "Animates one word inside a sentence from a base color to a brand color.",
+ description: "Animates one word inside a sentence from a base color to a brand color",
status: "stable",
href: "/docs/typography/inline-highlight",
},
{
name: "MarkerHighlight",
- description: "Marker bar sweeps in behind a phrase, optionally inverting the text color.",
+ description: "Marker bar sweeps in behind a phrase, optionally inverting the text color",
status: "stable",
href: "/docs/typography/marker-highlight",
},
{
name: "ShimmerSweep",
- description: "Bright gradient sweeps across dim text, lighting it up.",
+ description: "Bright gradient sweeps across dim text, lighting it up",
status: "stable",
href: "/docs/typography/shimmer-sweep",
},
@@ -67,7 +67,7 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
items={[
{
name: "Typewriter",
- description: "Character-by-character text reveal with a deterministic blinking cursor.",
+ description: "Character-by-character text reveal with a deterministic blinking cursor",
status: "stable",
href: "/docs/typography/typewriter",
},
@@ -79,7 +79,7 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
},
{
name: "SlotMachineRoll",
- description: "Numbers and characters roll into place like a casino reel.",
+ description: "Numbers and characters roll into place like a casino reel",
status: "stable",
href: "/docs/typography/slot-machine-roll",
},
@@ -92,13 +92,13 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
items={[
{
name: "InfiniteMarquee",
- description: "Endlessly scrolling horizontal text band.",
+ description: "Endlessly scrolling horizontal text band",
status: "stable",
href: "/docs/typography/infinite-marquee",
},
{
name: "PerspectiveMarquee",
- description: "Marquee tilted into 3D space with depth fade.",
+ description: "Marquee tilted into 3D space with depth fade",
status: "stable",
href: "/docs/typography/perspective-marquee",
},
@@ -111,13 +111,13 @@ Every way text can move, fade, glitch, or stretch across the screen. From quiet
items={[
{
name: "MatrixDecode",
- description: "Random characters scramble and resolve into the target string.",
+ description: "Random characters scramble and resolve into the target string",
status: "stable",
href: "/docs/typography/matrix-decode",
},
{
name: "RGBGlitchText",
- description: "Three-channel RGB split with a brief horizontal jitter.",
+ description: "Three-channel RGB split with a brief horizontal jitter",
status: "stable",
href: "/docs/typography/rgb-glitch-text",
},
diff --git a/content/docs/typography/infinite-marquee.mdx b/content/docs/typography/infinite-marquee.mdx
index 6bc82888..c99ded60 100644
--- a/content/docs/typography/infinite-marquee.mdx
+++ b/content/docs/typography/infinite-marquee.mdx
@@ -1,6 +1,6 @@
---
title: Infinite Marquee
-description: A continuously scrolling horizontal text strip that loops seamlessly.
+description: A continuously scrolling horizontal text strip that loops seamlessly
---
<ComponentPreview name="infinite-marquee" />
@@ -46,54 +46,54 @@ export const RemotionRoot = () => (
name: "fontSize",
type: "number",
default: "120",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color when `stroke` is false.",
+ description: "Text color when `stroke` is false",
},
{
name: "fontWeight",
type: "number",
default: "900",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "pixelsPerFrame",
type: "number",
default: "4",
- description: "Horizontal scroll speed in pixels per frame.",
+ description: "Horizontal scroll speed in pixels per frame",
},
{
name: "stroke",
type: "boolean",
default: "false",
- description: "Render outlined text via `-webkit-text-stroke` instead of filled.",
+ description: "Render outlined text via `-webkit-text-stroke` instead of filled",
},
{
name: "strokeColor",
type: "string",
default: "\"#171717\"",
- description: "Stroke color used when `stroke` is true.",
+ description: "Stroke color used when `stroke` is true",
},
{
name: "background",
type: "string",
default: "\"#fafafa\"",
- description: "Background color of the root container.",
+ description: "Background color of the root container",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the translating row.",
+ description: "Optional className passed to the translating row",
},
]}
/>
diff --git a/content/docs/typography/inline-highlight.mdx b/content/docs/typography/inline-highlight.mdx
index 42a1e770..3a62f4db 100644
--- a/content/docs/typography/inline-highlight.mdx
+++ b/content/docs/typography/inline-highlight.mdx
@@ -1,6 +1,6 @@
---
title: Inline Highlight
-description: Animate one word inside a sentence from a base color to a brand color.
+description: Animate one word inside a sentence from a base color to a brand color
---
<ComponentPreview name="inline-highlight" />
@@ -45,48 +45,48 @@ export const RemotionRoot = () => (
name: "before",
type: "string",
required: true,
- description: "Text rendered before the highlighted word.",
+ description: "Text rendered before the highlighted word",
},
{
name: "highlight",
type: "string",
required: true,
- description: "The word that animates color.",
+ description: "The word that animates color",
},
{
name: "after",
type: "string",
default: "\"\"",
- description: "Text rendered after the highlighted word.",
+ description: "Text rendered after the highlighted word",
},
{
name: "baseColor",
type: "string",
default: "\"#171717\"",
- description: "Starting color of the highlighted word and color of the surrounding text.",
+ description: "Starting color of the highlighted word and color of the surrounding text",
},
{
name: "highlightColor",
type: "string",
default: "\"#ff5e3a\"",
- description: "Final color of the highlighted word.",
+ description: "Final color of the highlighted word",
},
{
name: "fontSize",
type: "number",
default: "48",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/typography/marker-highlight.mdx b/content/docs/typography/marker-highlight.mdx
index 9b43711a..e20b0a84 100644
--- a/content/docs/typography/marker-highlight.mdx
+++ b/content/docs/typography/marker-highlight.mdx
@@ -1,6 +1,6 @@
---
title: Marker Highlight
-description: A colored marker block draws behind a phrase while the text color shifts.
+description: A colored marker block draws behind a phrase while the text color shifts
---
<ComponentPreview name="marker-highlight" />
@@ -45,60 +45,60 @@ export const RemotionRoot = () => (
name: "before",
type: "string",
default: "\"\"",
- description: "Text that appears before the highlighted phrase.",
+ description: "Text that appears before the highlighted phrase",
},
{
name: "highlight",
type: "string",
required: true,
- description: "The phrase the marker draws behind.",
+ description: "The phrase the marker draws behind",
},
{
name: "after",
type: "string",
default: "\"\"",
- description: "Text that appears after the highlighted phrase.",
+ description: "Text that appears after the highlighted phrase",
},
{
name: "markerColor",
type: "string",
default: "\"#facc15\"",
- description: "Color of the marker block.",
+ description: "Color of the marker block",
},
{
name: "baseColor",
type: "string",
default: "\"#171717\"",
- description: "Color of the surrounding text.",
+ description: "Color of the surrounding text",
},
{
name: "highlightedTextColor",
type: "string",
default: "\"#171717\"",
- description: "Final color of the highlighted phrase once the marker is drawn.",
+ description: "Final color of the highlighted phrase once the marker is drawn",
},
{
name: "fontSize",
type: "number",
default: "72",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier for animation speed.",
+ description: "Multiplier for animation speed",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer text span.",
+ description: "Optional className passed to the outer text span",
},
]}
/>
diff --git a/content/docs/typography/masked-slide-reveal.mdx b/content/docs/typography/masked-slide-reveal.mdx
index e20d4775..387aae51 100644
--- a/content/docs/typography/masked-slide-reveal.mdx
+++ b/content/docs/typography/masked-slide-reveal.mdx
@@ -1,6 +1,6 @@
---
title: Masked Slide Reveal
-description: Words rise out of an invisible horizontal mask with a springy motion.
+description: Words rise out of an invisible horizontal mask with a springy motion
---
<ComponentPreview name="masked-slide-reveal" />
@@ -46,36 +46,36 @@ export const RemotionRoot = () => (
name: "staggerDelay",
type: "number",
default: "3",
- description: "Frames between the start of each word's spring animation.",
+ description: "Frames between the start of each word's spring animation",
},
{
name: "fontSize",
type: "number",
default: "72",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color (any valid CSS color).",
+ description: "Text color (any valid CSS color)",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier (1 = normal, 2 = twice as fast).",
+ description: "Playback speed multiplier (1 = normal, 2 = twice as fast)",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/typography/matrix-decode.mdx b/content/docs/typography/matrix-decode.mdx
index 3ab45f2c..2c7da346 100644
--- a/content/docs/typography/matrix-decode.mdx
+++ b/content/docs/typography/matrix-decode.mdx
@@ -1,6 +1,6 @@
---
title: Matrix Decode
-description: Random scramble resolves left-to-right into target text.
+description: Random scramble resolves left-to-right into target text
---
<ComponentPreview name="matrix-decode" />
@@ -40,48 +40,48 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The final text the scramble resolves into.",
+ description: "The final text the scramble resolves into",
},
{
name: "charset",
type: "string",
default: "\"!@#$%^&*()_+-=<>?/\\\\|\"",
- description: "Pool of characters used while scrambling.",
+ description: "Pool of characters used while scrambling",
},
{
name: "fontSize",
type: "number",
default: "72",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "color",
type: "string",
default: "\"#22c55e\"",
- description: "Text color.",
+ description: "Text color",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "revealDuration",
type: "number",
default: "60",
- description: "How many frames it takes for the full text to decode.",
+ description: "How many frames it takes for the full text to decode",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier for animation speed.",
+ description: "Multiplier for animation speed",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the text span.",
+ description: "Optional className passed to the text span",
},
]}
/>
diff --git a/content/docs/typography/perspective-marquee.mdx b/content/docs/typography/perspective-marquee.mdx
index f110315f..a513b3f5 100644
--- a/content/docs/typography/perspective-marquee.mdx
+++ b/content/docs/typography/perspective-marquee.mdx
@@ -1,6 +1,6 @@
---
title: Perspective Marquee
-description: A 3D-tilted infinite marquee with depth-of-field blur on items rolling toward the horizon.
+description: A 3D-tilted infinite marquee with depth-of-field blur on items rolling toward the horizon
---
<ComponentPreview name="perspective-marquee" />
@@ -50,66 +50,66 @@ export const RemotionRoot = () => (
name: "fontSize",
type: "number",
default: "84",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "color",
type: "string",
default: "\"#fafafa\"",
- description: "Text color of each item.",
+ description: "Text color of each item",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "pixelsPerFrame",
type: "number",
default: "2",
- description: "Horizontal scroll speed in pixels per frame.",
+ description: "Horizontal scroll speed in pixels per frame",
},
{
name: "rotateY",
type: "number",
default: "-28",
- description: "Y-axis rotation in degrees applied to the marquee row.",
+ description: "Y-axis rotation in degrees applied to the marquee row",
},
{
name: "rotateX",
type: "number",
default: "8",
- description: "X-axis rotation in degrees applied to the marquee row.",
+ description: "X-axis rotation in degrees applied to the marquee row",
},
{
name: "perspective",
type: "number",
default: "1200",
- description: "CSS perspective in pixels on the parent.",
+ description: "CSS perspective in pixels on the parent",
},
{
name: "fadeColor",
type: "string",
default: "\"#050505\"",
- description: "Color used in the edge vignette gradients.",
+ description: "Color used in the edge vignette gradients",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Root container background color.",
+ description: "Root container background color",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/typography/rgb-glitch-text.mdx b/content/docs/typography/rgb-glitch-text.mdx
index 25c0c5c3..8dcbbc43 100644
--- a/content/docs/typography/rgb-glitch-text.mdx
+++ b/content/docs/typography/rgb-glitch-text.mdx
@@ -1,6 +1,6 @@
---
title: RGB Glitch Text
-description: Three RGB-offset text copies jitter for a few frames to create a chromatic aberration glitch.
+description: Three RGB-offset text copies jitter for a few frames to create a chromatic aberration glitch
---
<ComponentPreview name="rgb-glitch-text" />
@@ -40,60 +40,60 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The text to display and glitch.",
+ description: "The text to display and glitch",
},
{
name: "fontSize",
type: "number",
default: "96",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Base text color (visible at all times).",
+ description: "Base text color (visible at all times)",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "glitchAt",
type: "number",
default: "20",
- description: "Frame at which the glitch starts.",
+ description: "Frame at which the glitch starts",
},
{
name: "glitchDuration",
type: "number",
default: "8",
- description: "Duration of the glitch window in frames.",
+ description: "Duration of the glitch window in frames",
},
{
name: "intensity",
type: "number",
default: "6",
- description: "Maximum offset (in pixels) for the RGB copies.",
+ description: "Maximum offset (in pixels) for the RGB copies",
},
{
name: "seed",
type: "string",
default: "\"glitch\"",
- description: "Seed used by `random()` so the jitter stays deterministic.",
+ description: "Seed used by `random()` so the jitter stays deterministic",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier (1 = normal, 2 = twice as fast).",
+ description: "Playback speed multiplier (1 = normal, 2 = twice as fast)",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the inline-block wrapper.",
+ description: "Optional className passed to the inline-block wrapper",
},
]}
/>
diff --git a/content/docs/typography/shimmer-sweep.mdx b/content/docs/typography/shimmer-sweep.mdx
index ba78587c..1f84067d 100644
--- a/content/docs/typography/shimmer-sweep.mdx
+++ b/content/docs/typography/shimmer-sweep.mdx
@@ -1,6 +1,6 @@
---
title: Shimmer Sweep
-description: A bright shine travels across muted text to draw attention.
+description: A bright shine travels across muted text to draw attention
---
<ComponentPreview name="shimmer-sweep" />
@@ -40,42 +40,42 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The text to animate the shine across.",
+ description: "The text to animate the shine across",
},
{
name: "baseColor",
type: "string",
default: "\"#3f3f46\"",
- description: "Dim color of the text underneath the shine.",
+ description: "Dim color of the text underneath the shine",
},
{
name: "shineColor",
type: "string",
default: "\"#fafafa\"",
- description: "Color of the moving highlight gradient.",
+ description: "Color of the moving highlight gradient",
},
{
name: "fontSize",
type: "number",
default: "96",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier for animation speed.",
+ description: "Multiplier for animation speed",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the shine span.",
+ description: "Optional className passed to the shine span",
},
]}
/>
diff --git a/content/docs/typography/slot-machine-roll.mdx b/content/docs/typography/slot-machine-roll.mdx
index ac803746..eb0f0210 100644
--- a/content/docs/typography/slot-machine-roll.mdx
+++ b/content/docs/typography/slot-machine-roll.mdx
@@ -1,6 +1,6 @@
---
title: Slot Machine Roll
-description: Vertical reel scrolls each character from an old value to a new value.
+description: Vertical reel scrolls each character from an old value to a new value
---
<ComponentPreview name="slot-machine-roll" />
@@ -40,13 +40,13 @@ export const RemotionRoot = () => (
name: "from",
type: "string",
default: "\"$99\"",
- description: "Starting value shown before the reel rolls.",
+ description: "Starting value shown before the reel rolls",
},
{
name: "to",
type: "string",
default: "\"$199\"",
- description: "Target value the reel settles on.",
+ description: "Target value the reel settles on",
},
{
name: "fontSize",
@@ -58,24 +58,24 @@ export const RemotionRoot = () => (
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color.",
+ description: "Text color",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Multiplier for animation speed.",
+ description: "Multiplier for animation speed",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer text span.",
+ description: "Optional className passed to the outer text span",
},
]}
/>
diff --git a/content/docs/typography/staggered-fade-up.mdx b/content/docs/typography/staggered-fade-up.mdx
index c642a93a..7738eef1 100644
--- a/content/docs/typography/staggered-fade-up.mdx
+++ b/content/docs/typography/staggered-fade-up.mdx
@@ -1,6 +1,6 @@
---
title: Staggered Fade Up
-description: Words slide up and fade in sequentially with a wave-like cascade.
+description: Words slide up and fade in sequentially with a wave-like cascade
---
<ComponentPreview name="staggered-fade-up" />
@@ -46,42 +46,42 @@ export const RemotionRoot = () => (
name: "staggerDelay",
type: "number",
default: "4",
- description: "Frames between the start of each word's animation.",
+ description: "Frames between the start of each word's animation",
},
{
name: "distance",
type: "number",
default: "20",
- description: "Vertical distance in pixels each word travels upward.",
+ description: "Vertical distance in pixels each word travels upward",
},
{
name: "fontSize",
type: "number",
default: "72",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color (any valid CSS color).",
+ description: "Text color (any valid CSS color)",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier (1 = normal, 2 = twice as fast).",
+ description: "Playback speed multiplier (1 = normal, 2 = twice as fast)",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/typography/text-fade-replace.mdx b/content/docs/typography/text-fade-replace.mdx
index 786a665f..59c1d0cb 100644
--- a/content/docs/typography/text-fade-replace.mdx
+++ b/content/docs/typography/text-fade-replace.mdx
@@ -1,6 +1,6 @@
---
title: Text Fade Replace
-description: Cross-fade between two strings on the same line without layout shift.
+description: Cross-fade between two strings on the same line without layout shift
---
<ComponentPreview name="text-fade-replace" />
@@ -40,36 +40,36 @@ export const RemotionRoot = () => (
name: "from",
type: "string",
required: true,
- description: "Initial text shown at the start of the composition.",
+ description: "Initial text shown at the start of the composition",
},
{
name: "to",
type: "string",
required: true,
- description: "Replacement text shown at the end of the composition.",
+ description: "Replacement text shown at the end of the composition",
},
{
name: "fontSize",
type: "number",
default: "48",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color for both strings.",
+ description: "Text color for both strings",
},
{
name: "className",
type: "string",
- description: "Optional className passed to both spans.",
+ description: "Optional className passed to both spans",
},
]}
/>
@@ -105,46 +105,46 @@ import { StrikethroughReplace } from "@/components/remocn/strikethrough-replace"
name: "from",
type: "string",
required: true,
- description: "Original text that gets struck through.",
+ description: "Original text that gets struck through",
},
{
name: "to",
type: "string",
required: true,
- description: "Replacement text that fades in.",
+ description: "Replacement text that fades in",
},
{
name: "lineColor",
type: "string",
default: "\"#ff5e3a\"",
- description: "Color of the strikethrough bar.",
+ description: "Color of the strikethrough bar",
},
{
name: "fontSize",
type: "number",
default: "48",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color for both strings.",
+ description: "Text color for both strings",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying spans.",
+ description: "Optional className passed to the underlying spans",
},
]}
/>
<Note title="Three phases">
- The animation runs in three phases tied to `durationInFrames`: draw the strike line (0–40%), cross-fade to the new text (40–60%), then hold (60–100%).
+ The animation runs in three phases tied to `durationInFrames`: draw the strike line (0-40%), cross-fade to the new text (40-60%), then hold (60-100%).
</Note>
diff --git a/content/docs/typography/tracking-in.mdx b/content/docs/typography/tracking-in.mdx
index 851c06af..1b2969b2 100644
--- a/content/docs/typography/tracking-in.mdx
+++ b/content/docs/typography/tracking-in.mdx
@@ -1,6 +1,6 @@
---
title: Tracking In
-description: Letter-spacing collapses and blur clears with a springy entrance.
+description: Letter-spacing collapses and blur clears with a springy entrance
---
<ComponentPreview name="tracking-in" />
@@ -40,7 +40,7 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The text to animate.",
+ description: "The text to animate",
},
{
name: "startTracking",
@@ -58,30 +58,30 @@ export const RemotionRoot = () => (
name: "fontSize",
type: "number",
default: "96",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "700",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color (any valid CSS color).",
+ description: "Text color (any valid CSS color)",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier (1 = normal, 2 = twice as fast).",
+ description: "Playback speed multiplier (1 = normal, 2 = twice as fast)",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/typography/typewriter.mdx b/content/docs/typography/typewriter.mdx
index 5f5de66a..ec5f0e34 100644
--- a/content/docs/typography/typewriter.mdx
+++ b/content/docs/typography/typewriter.mdx
@@ -1,6 +1,6 @@
---
title: Typewriter
-description: Character-by-character text reveal with a deterministic blinking cursor.
+description: Character-by-character text reveal with a deterministic blinking cursor
---
<ComponentPreview name="typewriter" />
@@ -40,48 +40,48 @@ export const RemotionRoot = () => (
name: "text",
type: "string",
required: true,
- description: "The text to type out.",
+ description: "The text to type out",
},
{
name: "cursor",
type: "boolean",
default: "true",
- description: "Whether to render the blinking cursor at the end.",
+ description: "Whether to render the blinking cursor at the end",
},
{
name: "speed",
type: "number",
default: "20",
- description: "Typing speed in characters per second.",
+ description: "Typing speed in characters per second",
},
{
name: "fontSize",
type: "number",
default: "48",
- description: "Font size in pixels.",
+ description: "Font size in pixels",
},
{
name: "fontWeight",
type: "number",
default: "600",
- description: "CSS font-weight.",
+ description: "CSS font-weight",
},
{
name: "color",
type: "string",
default: "\"#171717\"",
- description: "Text color (any valid CSS color).",
+ description: "Text color (any valid CSS color)",
},
{
name: "cursorColor",
type: "string",
default: "\"#171717\"",
- description: "Color of the blinking cursor block.",
+ description: "Color of the blinking cursor block",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the underlying span.",
+ description: "Optional className passed to the underlying span",
},
]}
/>
diff --git a/content/docs/ui-blocks/ai-generate-overlay.mdx b/content/docs/ui-blocks/ai-generate-overlay.mdx
index c517d998..f5756f11 100644
--- a/content/docs/ui-blocks/ai-generate-overlay.mdx
+++ b/content/docs/ui-blocks/ai-generate-overlay.mdx
@@ -1,6 +1,6 @@
---
title: AI Generate Overlay
-description: A "thinking" overlay for AI-driven UI — source image blurs out under a shimmering dot grid while a glassy pill pulses, then the new image fades in on top.
+description: A "thinking" overlay for AI-driven UI, where the source image blurs out under a shimmering dot grid while a glassy pill pulses, then the new image fades in on top
---
<ComponentPreview name="ai-generate-overlay" />
@@ -47,25 +47,25 @@ export const RemotionRoot = () => (
name: "maxBlur",
type: "number",
default: "20",
- description: "Peak blur radius in pixels applied to the source image.",
+ description: "Peak blur radius in pixels applied to the source image",
},
{
name: "blurStartFrame",
type: "number",
default: "20",
- description: "Frame at which the blur ramp and dot grid begin.",
+ description: "Frame at which the blur ramp and dot grid begin",
},
{
name: "blurPeakFrame",
type: "number",
default: "40",
- description: "Frame at which the blur reaches `maxBlur` and the dot grid is fully on.",
+ description: "Frame at which the blur reaches `maxBlur` and the dot grid is fully on",
},
{
name: "revealStartFrame",
type: "number",
default: "110",
- description: "Frame at which the spring-driven generated-image fade-in fires.",
+ description: "Frame at which the spring-driven generated-image fade-in fires",
},
{
name: "pillText",
@@ -77,13 +77,13 @@ export const RemotionRoot = () => (
name: "accent",
type: "string",
default: "\"#a78bfa\"",
- description: "Accent color used for the pill's status dot and glow shadow.",
+ description: "Accent color used for the pill's status dot and glow shadow",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Page background visible behind both image layers.",
+ description: "Page background visible behind both image layers",
},
{
name: "sourceImageBg",
@@ -95,36 +95,36 @@ export const RemotionRoot = () => (
name: "generatedImageBg",
type: "string",
default: "cool radial+linear",
- description: "CSS background for the generated image layer that fades in.",
+ description: "CSS background for the generated image layer that fades in",
},
{
name: "dotColor",
type: "string",
default: "\"#ffffff\"",
- description: "Fill color of the SVG dot grid.",
+ description: "Fill color of the SVG dot grid",
},
{
name: "dotSize",
type: "number",
default: "1.2",
- description: "Radius of each dot in the grid.",
+ description: "Radius of each dot in the grid",
},
{
name: "dotSpacing",
type: "number",
default: "20",
- description: "Pattern tile size — controls the spacing between dots.",
+ description: "Pattern tile size that controls the spacing between dots",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier for all timing values.",
+ description: "Playback speed multiplier for all timing values",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/ui-blocks/animated-bar-chart.mdx b/content/docs/ui-blocks/animated-bar-chart.mdx
index fcbe65f2..02dff9ea 100644
--- a/content/docs/ui-blocks/animated-bar-chart.mdx
+++ b/content/docs/ui-blocks/animated-bar-chart.mdx
@@ -1,6 +1,6 @@
---
title: Animated Bar Chart
-description: Bars spring up from the baseline with a staggered cascade.
+description: Bars spring up from the baseline with a staggered cascade
---
<ComponentPreview name="animated-bar-chart" />
@@ -48,48 +48,48 @@ export const RemotionRoot = () => (
{
name: "labels",
type: "string[]",
- description: "Optional labels rendered under each bar.",
+ description: "Optional labels rendered under each bar",
},
{
name: "width",
type: "number",
default: "1000",
- description: "SVG viewBox width.",
+ description: "SVG viewBox width",
},
{
name: "height",
type: "number",
default: "500",
- description: "SVG viewBox height.",
+ description: "SVG viewBox height",
},
{
name: "barColor",
type: "string",
default: "\"#0ea5e9\"",
- description: "Fill color used for every bar.",
+ description: "Fill color used for every bar",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "gap",
type: "number",
default: "16",
- description: "Pixel gap between bars.",
+ description: "Pixel gap between bars",
},
{
name: "staggerFrames",
type: "number",
default: "6",
- description: "Frame delay applied to each successive bar.",
+ description: "Frame delay applied to each successive bar",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/animated-line-chart.mdx b/content/docs/ui-blocks/animated-line-chart.mdx
index 0c45e017..051d2664 100644
--- a/content/docs/ui-blocks/animated-line-chart.mdx
+++ b/content/docs/ui-blocks/animated-line-chart.mdx
@@ -1,6 +1,6 @@
---
title: Animated Line Chart
-description: A line chart whose path draws on from left to right.
+description: A line chart whose path draws on from left to right
---
<ComponentPreview name="animated-line-chart" />
@@ -49,48 +49,48 @@ export const RemotionRoot = () => (
name: "width",
type: "number",
default: "1000",
- description: "SVG viewBox width.",
+ description: "SVG viewBox width",
},
{
name: "height",
type: "number",
default: "500",
- description: "SVG viewBox height.",
+ description: "SVG viewBox height",
},
{
name: "strokeColor",
type: "string",
default: "\"#22c55e\"",
- description: "Color of the line stroke.",
+ description: "Color of the line stroke",
},
{
name: "strokeWidth",
type: "number",
default: "4",
- description: "Line stroke width in pixels.",
+ description: "Line stroke width in pixels",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "gridColor",
type: "string",
default: "\"#27272a\"",
- description: "Grid and axis line color.",
+ description: "Grid and axis line color",
},
{
name: "showDot",
type: "boolean",
default: "true",
- description: "Render a dot at the leading edge of the line as it draws.",
+ description: "Render a dot at the leading edge of the line as it draws",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/code-accordion.mdx b/content/docs/ui-blocks/code-accordion.mdx
index 5bdabe4d..fde5fac5 100644
--- a/content/docs/ui-blocks/code-accordion.mdx
+++ b/content/docs/ui-blocks/code-accordion.mdx
@@ -1,6 +1,6 @@
---
title: Code Accordion
-description: A code window that springs a range of lines closed and replaces them with a "N lines collapsed" placeholder.
+description: A code window that springs a range of lines closed and replaces them with a "N lines collapsed" placeholder
---
<ComponentPreview name="code-accordion" />
@@ -49,66 +49,66 @@ export const RemotionRoot = () => (
name: "collapseRange",
type: "[number, number]",
default: "[3, 14]",
- description: "Inclusive 0-based start and end line indices that will collapse.",
+ description: "Inclusive 0-based start and end line indices that will collapse",
},
{
name: "collapseAt",
type: "number",
default: "30",
- description: "Frame at which the collapse spring fires.",
+ description: "Frame at which the collapse spring fires",
},
{
name: "title",
type: "string",
default: "\"process-orders.ts\"",
- description: "Filename shown in the chrome bar.",
+ description: "Filename shown in the chrome bar",
},
{
name: "fontSize",
type: "number",
default: "16",
- description: "Code font size in pixels.",
+ description: "Code font size in pixels",
},
{
name: "width",
type: "number",
default: "720",
- description: "Window width in pixels.",
+ description: "Window width in pixels",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Page background color.",
+ description: "Page background color",
},
{
name: "cardColor",
type: "string",
default: "\"#0a0a0a\"",
- description: "Editor surface color.",
+ description: "Editor surface color",
},
{
name: "textColor",
type: "string",
default: "\"#e4e4e7\"",
- description: "Code color.",
+ description: "Code color",
},
{
name: "mutedColor",
type: "string",
default: "\"#52525b\"",
- description: "Line numbers and placeholder bar color.",
+ description: "Line numbers and placeholder bar color",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/ui-blocks/code-diff-wipe.mdx b/content/docs/ui-blocks/code-diff-wipe.mdx
index 36801341..385757d9 100644
--- a/content/docs/ui-blocks/code-diff-wipe.mdx
+++ b/content/docs/ui-blocks/code-diff-wipe.mdx
@@ -1,6 +1,6 @@
---
title: Code Diff Wipe
-description: Reveal an "after" code snippet by wiping a "before" snippet away.
+description: Reveal an "after" code snippet by wiping a "before" snippet away
---
<ComponentPreview name="code-diff-wipe" />
@@ -42,53 +42,53 @@ export const RemotionRoot = () => (
{
name: "before",
type: "string",
- description: "Multi-line code shown on top, wiped away by the animation.",
+ description: "Multi-line code shown on top, wiped away by the animation",
},
{
name: "after",
type: "string",
- description: "Multi-line code revealed underneath as the wipe progresses.",
+ description: "Multi-line code revealed underneath as the wipe progresses",
},
{
name: "language",
type: "string",
default: "\"tsx\"",
- description: "Language label shown in the pane header.",
+ description: "Language label shown in the pane header",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Editor background color.",
+ description: "Editor background color",
},
{
name: "accent",
type: "string",
default: "\"#0ea5e9\"",
- description: "Accent color for the wipe line, handle, and \"after\" label.",
+ description: "Accent color for the wipe line, handle, and \"after\" label",
},
{
name: "transitionStart",
type: "number",
default: "20",
- description: "Frame at which the wipe begins.",
+ description: "Frame at which the wipe begins",
},
{
name: "transitionDuration",
type: "number",
default: "60",
- description: "Number of frames the wipe takes from 0% to 100%.",
+ description: "Number of frames the wipe takes from 0% to 100%",
},
{
name: "showHandle",
type: "boolean",
default: "true",
- description: "Render a circular handle on the wipe line.",
+ description: "Render a circular handle on the wipe line",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/data-flow-pipes.mdx b/content/docs/ui-blocks/data-flow-pipes.mdx
index 04c4f4a1..1a078dfa 100644
--- a/content/docs/ui-blocks/data-flow-pipes.mdx
+++ b/content/docs/ui-blocks/data-flow-pipes.mdx
@@ -1,6 +1,6 @@
---
title: Data Flow Pipes
-description: Glowing data packets travel along SVG bezier pipes between system nodes, leaving fading trails.
+description: Glowing data packets travel along SVG bezier pipes between system nodes, leaving fading trails
---
<ComponentPreview name="data-flow-pipes" />
@@ -60,54 +60,54 @@ export const RemotionRoot = () => (
name: "pipeColor",
type: "string",
default: "\"#1f1f23\"",
- description: "Color of the static pipe stroke.",
+ description: "Color of the static pipe stroke",
},
{
name: "pulseColor",
type: "string",
default: "\"#22d3ee\"",
- description: "Color of the moving pulse and its glow.",
+ description: "Color of the moving pulse and its glow",
},
{
name: "pulseLength",
type: "number",
default: "60",
- description: "Length of the bright dash in pixels.",
+ description: "Length of the bright dash in pixels",
},
{
name: "pulseDuration",
type: "number",
default: "36",
- description: "Frames a single pulse takes to traverse its edge.",
+ description: "Frames a single pulse takes to traverse its edge",
},
{
name: "background",
type: "string",
default: "\"#050505\"",
- description: "Page background color.",
+ description: "Page background color",
},
{
name: "nodeColor",
type: "string",
default: "\"#0a0a0a\"",
- description: "Node card background color.",
+ description: "Node card background color",
},
{
name: "textColor",
type: "string",
default: "\"#fafafa\"",
- description: "Node label color.",
+ description: "Node label color",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/ui-blocks/drag-and-drop-flow.mdx b/content/docs/ui-blocks/drag-and-drop-flow.mdx
index 613d4479..f39639cc 100644
--- a/content/docs/ui-blocks/drag-and-drop-flow.mdx
+++ b/content/docs/ui-blocks/drag-and-drop-flow.mdx
@@ -1,6 +1,6 @@
---
title: Drag And Drop Flow
-description: Simulates dragging a file into a drop zone, then a progress bar fills.
+description: Simulates dragging a file into a drop zone, then a progress bar fills
---
<ComponentPreview name="drag-and-drop-flow" />
@@ -44,30 +44,30 @@ export const RemotionRoot = () => (
name: "accent",
type: "string",
default: "\"#0ea5e9\"",
- description: "Accent color for the file icon, dropzone highlight, and progress bar.",
+ description: "Accent color for the file icon, dropzone highlight, and progress bar",
},
{
name: "dropzoneLabel",
type: "string",
default: "\"Drop file to upload\"",
- description: "Label rendered inside the dropzone.",
+ description: "Label rendered inside the dropzone",
},
{
name: "fileName",
type: "string",
default: "\"design.fig\"",
- description: "File name shown above the progress bar.",
+ description: "File name shown above the progress bar",
},
{
name: "background",
type: "string",
default: "\"#fafafa\"",
- description: "Frame background color.",
+ description: "Frame background color",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/dynamic-split-screen.mdx b/content/docs/ui-blocks/dynamic-split-screen.mdx
index 2237898c..d560d2cf 100644
--- a/content/docs/ui-blocks/dynamic-split-screen.mdx
+++ b/content/docs/ui-blocks/dynamic-split-screen.mdx
@@ -1,6 +1,6 @@
---
title: Dynamic Split Screen
-description: Cinematic two-column split where one panel shrinks and the other expands into view.
+description: Cinematic two-column split where one panel shrinks and the other expands into view
---
<ComponentPreview name="chat-to-preview-layout" />
@@ -51,24 +51,24 @@ export const RemotionRoot = () => (
name: "startChatRatio",
type: "number",
default: "0.5",
- description: "Initial fraction of width given to the chat panel (0..1).",
+ description: "Initial fraction of width given to the chat panel (0..1)",
},
{
name: "endChatRatio",
type: "number",
default: "0.25",
- description: "Final fraction of width given to the chat panel (0..1).",
+ description: "Final fraction of width given to the chat panel (0..1)",
},
{
name: "background",
type: "string",
default: '"#0a0a0a"',
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/glass-code-block.mdx b/content/docs/ui-blocks/glass-code-block.mdx
index ee5cdadc..a4c138cb 100644
--- a/content/docs/ui-blocks/glass-code-block.mdx
+++ b/content/docs/ui-blocks/glass-code-block.mdx
@@ -1,6 +1,6 @@
---
title: Glass Code Block
-description: A premium frosted-glass code editor window with a regex tokenizer and line-by-line stagger reveal.
+description: A premium frosted-glass code editor window with a regex tokenizer and line-by-line stagger reveal
---
<ComponentPreview name="glass-code-block" />
@@ -48,31 +48,31 @@ export const RemotionRoot = () => (
name: "title",
type: "string",
default: "\"hero.tsx\"",
- description: "Filename shown in the chrome bar.",
+ description: "Filename shown in the chrome bar",
},
{
name: "width",
type: "number",
default: "760",
- description: "Window width in pixels.",
+ description: "Window width in pixels",
},
{
name: "height",
type: "number",
default: "460",
- description: "Window height in pixels.",
+ description: "Window height in pixels",
},
{
name: "fontSize",
type: "number",
default: "16",
- description: "Code font size in pixels.",
+ description: "Code font size in pixels",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Background color around the window.",
+ description: "Background color around the window",
},
{
name: "glassColor",
@@ -84,24 +84,24 @@ export const RemotionRoot = () => (
name: "staggerFrames",
type: "number",
default: "4",
- description: "Frames between each line's reveal.",
+ description: "Frames between each line's reveal",
},
{
name: "showTrafficLights",
type: "boolean",
default: "true",
- description: "Show the dimmed macOS-style window controls.",
+ description: "Show the dimmed macOS-style window controls",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>
diff --git a/content/docs/ui-blocks/index.mdx b/content/docs/ui-blocks/index.mdx
index 654a9335..fdbbaf68 100644
--- a/content/docs/ui-blocks/index.mdx
+++ b/content/docs/ui-blocks/index.mdx
@@ -1,9 +1,9 @@
---
title: UI Blocks
-description: Pre-assembled interface elements — code editors, layouts, charts, and workflow visualizations.
+description: Pre-assembled interface elements like code editors, layouts, charts, and workflow visualizations
---
-Larger blocks built from primitives — the actual surfaces your viewers will recognize: code windows, terminals, charts, dashboards, and workflow diagrams.
+Larger blocks built from primitives, the actual surfaces your viewers will recognize: code windows, terminals, charts, dashboards, and workflow diagrams.
## Code & CLI
@@ -11,25 +11,25 @@ Larger blocks built from primitives — the actual surfaces your viewers will re
items={[
{
name: "GlassCodeBlock",
- description: "Premium frosted-glass code window with rim light and traffic-light controls.",
+ description: "Premium frosted-glass code window with rim light and traffic-light controls",
status: "stable",
href: "/docs/ui-blocks/glass-code-block",
},
{
name: "TerminalSimulator",
- description: "CLI build simulation with chunked log output and step-function scrolling.",
+ description: "CLI build simulation with chunked log output and step-function scrolling",
status: "stable",
href: "/docs/ui-blocks/terminal-simulator",
},
{
name: "CodeAccordion",
- description: "Long code blocks collapse mid-section, hiding noise behind a count badge.",
+ description: "Long code blocks collapse mid-section, hiding noise behind a count badge",
status: "stable",
href: "/docs/ui-blocks/code-accordion",
},
{
name: "CodeDiffWipe",
- description: "Before/after comparison with a clip-path slider revealing the new code.",
+ description: "Before/after comparison with a clip-path slider revealing the new code",
status: "stable",
href: "/docs/ui-blocks/code-diff-wipe",
},
@@ -42,13 +42,13 @@ Larger blocks built from primitives — the actual surfaces your viewers will re
items={[
{
name: "StaggeredBentoGrid",
- description: "Bento grid where cards cascade in with per-cell sequences.",
+ description: "Bento grid where cards cascade in with per-cell sequences",
status: "stable",
href: "/docs/ui-blocks/staggered-bento-grid",
},
{
name: "DynamicSplitScreen",
- description: "Two-column split where one panel shrinks and the other expands into view.",
+ description: "Two-column split where one panel shrinks and the other expands into view",
status: "stable",
href: "/docs/ui-blocks/dynamic-split-screen",
},
@@ -61,19 +61,19 @@ Larger blocks built from primitives — the actual surfaces your viewers will re
items={[
{
name: "AnimatedLineChart",
- description: "SVG line chart drawn left-to-right via stroke-dashoffset.",
+ description: "SVG line chart drawn left-to-right via stroke-dashoffset",
status: "stable",
href: "/docs/ui-blocks/animated-line-chart",
},
{
name: "AnimatedBarChart",
- description: "Bars spring up from the baseline with deterministic stagger.",
+ description: "Bars spring up from the baseline with deterministic stagger",
status: "stable",
href: "/docs/ui-blocks/animated-bar-chart",
},
{
name: "DataFlowPipes",
- description: "Glowing data packets fly along SVG pipes with trailing tails.",
+ description: "Glowing data packets fly along SVG pipes with trailing tails",
status: "stable",
href: "/docs/ui-blocks/data-flow-pipes",
},
@@ -86,13 +86,13 @@ Larger blocks built from primitives — the actual surfaces your viewers will re
items={[
{
name: "ProgressSteps",
- description: "Multi-step pipeline visualization with line fill and pulsing dots.",
+ description: "Multi-step pipeline visualization with line fill and pulsing dots",
status: "stable",
href: "/docs/ui-blocks/progress-steps",
},
{
name: "DragAndDropFlow",
- description: "Cursor drags a file into a drop zone that lights up and starts a progress bar.",
+ description: "Cursor drags a file into a drop zone that lights up and starts a progress bar",
status: "stable",
href: "/docs/ui-blocks/drag-and-drop-flow",
},
diff --git a/content/docs/ui-blocks/progress-steps.mdx b/content/docs/ui-blocks/progress-steps.mdx
index aee9fd9a..ec5534de 100644
--- a/content/docs/ui-blocks/progress-steps.mdx
+++ b/content/docs/ui-blocks/progress-steps.mdx
@@ -1,6 +1,6 @@
---
title: Progress Steps
-description: Multi-step pipeline with nodes lighting up sequentially.
+description: Multi-step pipeline with nodes lighting up sequentially
---
<ComponentPreview name="progress-steps" />
@@ -56,36 +56,36 @@ export const RemotionRoot = () => (
name: "activeColor",
type: "string",
default: "\"#22c55e\"",
- description: "Fill color used once a step has been activated.",
+ description: "Fill color used once a step has been activated",
},
{
name: "inactiveColor",
type: "string",
default: "\"#27272a\"",
- description: "Fill color used before a step is activated.",
+ description: "Fill color used before a step is activated",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Frame background color.",
+ description: "Frame background color",
},
{
name: "textColor",
type: "string",
default: "\"white\"",
- description: "Color of the step label.",
+ description: "Color of the step label",
},
{
name: "stepDuration",
type: "number",
default: "30",
- description: "Number of frames between successive step activations.",
+ description: "Number of frames between successive step activations",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/staggered-bento-grid.mdx b/content/docs/ui-blocks/staggered-bento-grid.mdx
index abb49e0d..5aa94881 100644
--- a/content/docs/ui-blocks/staggered-bento-grid.mdx
+++ b/content/docs/ui-blocks/staggered-bento-grid.mdx
@@ -1,6 +1,6 @@
---
title: Staggered Bento Grid
-description: Cards pop into a bento grid one after another with a spring.
+description: Cards pop into a bento grid one after another with a spring
---
<ComponentPreview name="staggered-bento-grid" />
@@ -47,42 +47,42 @@ export const RemotionRoot = () => (
name: "items",
type: "Array<{ title: string; body?: string; span?: 1 | 2 }>",
default: "6 sample cards",
- description: "Cards to render in the grid.",
+ description: "Cards to render in the grid",
},
{
name: "staggerDelay",
type: "number",
default: "8",
- description: "Frames between each card's entrance.",
+ description: "Frames between each card's entrance",
},
{
name: "columns",
type: "number",
default: "3",
- description: "Number of grid columns.",
+ description: "Number of grid columns",
},
{
name: "background",
type: "string",
default: '"#0a0a0a"',
- description: "Outer background color.",
+ description: "Outer background color",
},
{
name: "cardColor",
type: "string",
default: '"#1a1a1a"',
- description: "Card background color.",
+ description: "Card background color",
},
{
name: "textColor",
type: "string",
default: '"white"',
- description: "Card text color.",
+ description: "Card text color",
},
{
name: "className",
type: "string",
- description: "Optional className for the outer container.",
+ description: "Optional className for the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/terminal-simulator.mdx b/content/docs/ui-blocks/terminal-simulator.mdx
index 399e9bb0..c903c943 100644
--- a/content/docs/ui-blocks/terminal-simulator.mdx
+++ b/content/docs/ui-blocks/terminal-simulator.mdx
@@ -1,6 +1,6 @@
---
title: Terminal Simulator
-description: A console window that types out commands and rolls older lines off the top.
+description: A console window that types out commands and rolls older lines off the top
---
<ComponentPreview name="terminal-simulator" />
@@ -50,42 +50,42 @@ export const RemotionRoot = () => (
name: "prompt",
type: "string",
default: "\"$\"",
- description: "Prompt prefix shown before `command` lines.",
+ description: "Prompt prefix shown before `command` lines",
},
{
name: "title",
type: "string",
default: "\"~/projects/remocn\"",
- description: "Title shown in the window chrome bar.",
+ description: "Title shown in the window chrome bar",
},
{
name: "background",
type: "string",
default: "\"#0a0a0a\"",
- description: "Terminal background color.",
+ description: "Terminal background color",
},
{
name: "chromeColor",
type: "string",
default: "\"#1a1a1a\"",
- description: "Window chrome bar color.",
+ description: "Window chrome bar color",
},
{
name: "fontSize",
type: "number",
default: "18",
- description: "Monospace font size in pixels.",
+ description: "Monospace font size in pixels",
},
{
name: "charsPerFrame",
type: "number",
default: "1",
- description: "Typing speed: how many characters appear per frame.",
+ description: "Typing speed: how many characters appear per frame",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the outer container.",
+ description: "Optional className passed to the outer container",
},
]}
/>
diff --git a/content/docs/ui-blocks/tool-menu-slide-in.mdx b/content/docs/ui-blocks/tool-menu-slide-in.mdx
index 8b6e636f..fbd19c58 100644
--- a/content/docs/ui-blocks/tool-menu-slide-in.mdx
+++ b/content/docs/ui-blocks/tool-menu-slide-in.mdx
@@ -1,6 +1,6 @@
---
title: Tool Menu Slide In
-description: A horizontal pill of tool icons whips up from below the canvas, then each icon pops in with a staggered spring.
+description: A horizontal pill of tool icons whips up from below the canvas, then each icon pops in with a staggered spring
---
<ComponentPreview name="tool-menu-slide-in" />
@@ -45,54 +45,54 @@ export const RemotionRoot = () => (
name: "panelStartFrame",
type: "number",
default: "18",
- description: "Frame at which the panel begins sliding up.",
+ description: "Frame at which the panel begins sliding up",
},
{
name: "iconStagger",
type: "number",
default: "4",
- description: "Frames of delay between each icon's pop-in spring.",
+ description: "Frames of delay between each icon's pop-in spring",
},
{
name: "iconCount",
type: "number",
default: "5",
- description: "Number of fake tool icons to render (clamped 1–8).",
+ description: "Number of fake tool icons to render (clamped 1-8)",
},
{
name: "accent",
type: "string",
default: "\"#a78bfa\"",
- description: "Accent color used for the active icon glow and border.",
+ description: "Accent color used for the active icon glow and border",
},
{
name: "panelColor",
type: "string",
default: "\"rgba(18, 18, 22, 0.72)\"",
- description: "Frosted-glass fill of the menu pill.",
+ description: "Frosted-glass fill of the menu pill",
},
{
name: "background",
type: "string",
default: "\"#070708\"",
- description: "Background color of the editor canvas.",
+ description: "Background color of the editor canvas",
},
{
name: "iconBg",
type: "string",
default: "\"rgba(255,255,255,0.06)\"",
- description: "Background of inactive tool icons.",
+ description: "Background of inactive tool icons",
},
{
name: "speed",
type: "number",
default: "1",
- description: "Playback speed multiplier.",
+ description: "Playback speed multiplier",
},
{
name: "className",
type: "string",
- description: "Optional className passed to the root container.",
+ description: "Optional className passed to the root container",
},
]}
/>