Skip to content

API overview ​

The npm surface is src/public-api/index.ts. Full generated list: API report.

You needGuideAPI page
Create / validate a documentData modelCore — model, schema, ops
Fill TemplateTemplate
Backend slot mapBackend slotsvelo-text/api-report
Mount the editorEditorEditor web
ExportExportExport, layout
AssetsAssetsAssets
ThemeThemesTheme
HostsAdaptersAdapters, public
ts
export {
  createDocument, createIdGenerator, createSystemClock,
  createParagraph, createHeading, createText, createVariable, createImageBlock, createTable, createEquation, createEquationBlock,
  validateDocument, assertValid, canonicalStringify, canonicalBytes, contentHashHex,
  normalizeDocument, isIdempotent, createTransaction,
  createCollapsedSelection, createRangeSelection, History,
  parseVariableSource, tokenizeVariablesInText, safeResolve, formatValue, renderTemplate, inspectVariables,
  XmlWriter, crc32, ZipWriter, PdfWriter, exportDocument,
  sniffImage, getDimensions, sanitizeSvg, getIconSvg, validateLatex,
  themes, themeCss, renderDocumentToHtml, registerCommand,
};

Ports: BinarySink, AssetResolver, Clock, IdGenerator.

exportDocument({ format: "pdf" | "odt" | "docx" }). OdtWriter / DocxWriter are re-exported.

Extensions: registerNodeType, registerFormatter, registerCommand, registerPlugin.

Zero runtime dependencies — TypeScript strict — MIT