API Reference¶

Use this section as the human guide to the public API surface.

These pages focus on:

• when to use each API
• recommended integration patterns
• pitfalls and lifecycle/performance guidance

For exhaustive signatures, parameters, properties, and generated KDoc, use Dokka.

Human reference guides¶

UI APIs¶

• SyntaxHighlightedCode - primary read-only code block composable
• SyntaxHighlightedTextEditor - experimental editable code field
• CodeBlockStyle - visual styling for code block layout and density

Engine and theme APIs¶

• HighlightEngine - low-level highlighting pipeline and lifecycle control
• HighlightTheme - theme creation and identity behavior
• HighlightLanguage - extension-to-language mapping helper

Full generated API (Dokka)¶

• Dokka API Docs

Quick-entry Dokka pages:

• dev.hossain.highlight.ui
• dev.hossain.highlight.engine