Public API

API

The public API is split by use case: core data operations, secure rendering, CLI usage, framework wrappers, Markdown plugins, Vite imports, and CI rendering.

@xcon-viewer/core

Parse, serialize, convert, normalize, and validate XCON documents.

@xcon-viewer/viewer

Render XCON documents to DOM or HTML and register the Web Component.

@xcon-viewer/cli

Use xcon validate, xcon convert, xcon format, and xcon render.

@xcon-viewer/react

React wrapper for the <xcon-viewer> Web Component.

@xcon-viewer/vue

Vue wrapper for the <xcon-viewer> Web Component.

Markdown and CI

Use markdown-it, remark, Vite, and GitHub Action packages.

HTML

<script type="module" src="https://unpkg.com/@xcon-viewer/viewer@0.1.0/dist/web-component.js"></script>
<xcon-viewer src="./home.xcon.json"></xcon-viewer>

JavaScript

import { render, renderToHtml } from '@xcon-viewer/viewer';

render({ type: 'form' }, document.getElementById('root'));
console.log(renderToHtml({ type: 'form' }));

render() and <xcon-viewer> create a positioned viewer host automatically. Use renderToHtml() for raw fragments only; if you insert that fragment yourself, wrap it in a position: relative frame or use renderDocument().

API