Skip to content

OverlayInput

OverlayInput = string | ReactElementLike | OverlayConfig | EditorOverlayInput | DependencyOverlayInput

Defined in: asset.ts:614

A value accepted by createOverlays for each key:

  • a string file path (.tsx/.solid.tsx/.vue/.svelte/.html/.svg/.png/.mp4),
  • a React element (<Badge label="New" />, shorthand for { element }),
  • an OverlayConfig object,
  • { editor: '<name>' } for a backend-hosted, editor-uploaded overlay, or
  • a selected render dependency.