docs-demo

Adding an Interactive Demo to Docs

Interactive demos render a Remotion composition inline in documentation pages using @remotion/player. They live in packages/docs/components/demos/.

Steps

1. Create a component in packages/docs/components/demos/ (e.g. MyDemo.tsx). It should be a standard React component using Remotion hooks like useCurrentFrame() and useVideoConfig().

1. Register the demo in packages/docs/components/demos/types.ts:
2. Import the component
3. Export a DemoType object with these fields:
4. id: unique string used in <Demo type="..." />
5. comp: the React component
6. compWidth / compHeight: canvas dimensions (e.g. 1280x720)
7. fps: frame rate (typically 30)
8. durationInFrames: animation length
9. autoPlay: whether it plays automatically
10. options: array of interactive controls (can be empty [])

1. Add to the demos array in packages/docs/components/demos/index.tsx:
2. Import the demo constant from ./types
3. Add it to the demos array

1. Use in MDX with <Demo type="your-id" />

Options

Options add interactive controls below the player. Each option needs name and optional ('no', 'default-enabled', or 'default-disabled').

Supported types:

• type: 'numeric' — slider with min, max, step, default
• type: 'boolean' — checkbox with default
• type: 'enum' — dropdown with values array and default
• type: 'string' — text input with default

Option values are passed to the component as inputProps. Access them as regular React props.

Example registration

export const myDemo: DemoType = {
  comp: MyDemoComp,
  compHeight: 720,
  compWidth: 1280,
  durationInFrames: 150,
  fps: 30,
  id: 'my-demo',
  autoPlay: true,
  options: [],
};