Skip to content

Write HTML. Render video. Built for agents.

1.8 KB
Raw Blame
{
  "$schema": "https://hyperframes.heygen.com/schema/registry-item.json",
  "name": "typewriter",
  "type": "hyperframes:component",
  "title": "Typewriter",
  "description": "Character-by-character text reveal with a deterministic blinking cursor.",
  "tags": ["video-primitive", "motion-primitive", "typography"],
  "files": [
    {
      "path": "typewriter.html",
      "target": "compositions/components/typewriter.html",
      "type": "hyperframes:snippet"
    }
  ],
  "variables": [
    {
      "id": "text",
      "type": "string",
      "role": "content",
      "label": "Text",
      "description": "Line that types itself out character by character.",
      "default": "hyperframes add typewriter"
    },
    {
      "id": "tone",
      "type": "enum",
      "role": "style",
      "label": "Tone",
      "description": "Colour of the text and the caret: ink for light frames, paper for dark ones, accent rides --brand.",
      "default": "ink",
      "options": [
        {
          "value": "ink",
          "label": "Ink"
        },
        {
          "value": "paper",
          "label": "Paper"
        },
        {
          "value": "accent",
          "label": "Accent"
        }
      ]
    },
    {
      "id": "caret",
      "type": "enum",
      "role": "style",
      "label": "Caret",
      "description": "Caret shape: a thin rule, a terminal-style block, or no caret at all.",
      "default": "line",
      "options": [
        {
          "value": "line",
          "label": "Line"
        },
        {
          "value": "block",
          "label": "Block"
        },
        {
          "value": "none",
          "label": "None"
        }
      ]
    }
  ],
  "preview": {
    "poster": "https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/typewriter.png"
  }
}