open-slide

Slide module exports

The shape the runtime expects from each slides/<id>/index.tsx.

slides/<id>/index.tsx
import type { Page, SlideMeta } from '@open-slide/core';

const Cover: Page = () => <div>{/* ... */}</div>;

export const meta: SlideMeta = {
  title: 'Cover',
  theme: 'corporate',
};

export const notes = {
  0: 'Open with the analyst quote.',
};

export default [Cover] satisfies Page[];

Default export

Page[] — the array of components, in display order. Each component fills its container; the runtime renders one at a time onto the 1920×1080 canvas.

type Page = ComponentType;

meta (optional)

type SlideMeta = {
  /** Display title for the deck — used in the slide browser. */
  title?: string;
  /** Name of a theme under `themes/<id>.md`. The agent reads it before authoring. */
  theme?: string;
};

notes (optional)

A map of page index → markdown string. Surfaced in presenter mode.

export const notes: Record<number, string> = {
  0: 'Open with a smile.',
  3: 'Pause for questions.',
};

transition (optional)

A module-level SlideTransition becomes the default animation between every page in the deck. Per-page overrides are assigned on the Page component itself. See SlideTransition for the full schema and a tasteful family of defaults.

import type { SlideTransition } from '@open-slide/core';

export const transition: SlideTransition = {
  duration: 200,
  exit:  { /* … */ },
  enter: { /* … */ },
};

Imports from @open-slide/core

import {
  CANVAS_WIDTH,        // 1920
  CANVAS_HEIGHT,       // 1080
  ImagePlaceholder,    // sized empty placeholder — see /docs/reference/image-placeholder
} from '@open-slide/core';
import type {
  Page,
  SlideMeta,
  SlideModule,
  SlideTransition,     // per-page / module-level animations — see /docs/reference/slide-transitions
  TransitionPhase,
  ImagePlaceholderProps,
} from '@open-slide/core';

On this page