API Reference
The reference below is generated by DocC from the in-source
documentation comments and curated ## Topics sections of
each catalog. The four modules are bundled into a single combined
archive, so symbols cross-reference correctly across boundaries.
For narrative documentation — architecture, runtime, design rationale — see design. For tutorials, see learn. The API reference is for symbol-level lookup.
Modules
Each product has a curated module landing with topic groups for the symbols an author actually uses first.
DefaultRenderer, RunLoop, App / Scene / WindowGroup, terminal host integration, and capability-aware presentation.
Runtime · import TerminalUIThe SwiftUI-shaped authoring surface — body-only View, ViewModifier algebra, layouts, controls, focus, gestures, Canvas.
Authoring · All the body-only typesThe pure pipeline data model: geometry, layout engine, semantic extractor, rasterizer, commit planner.
Pipeline · Pipeline + data productsCompact chart and metric views — BarChart, Sparkline, Meter, ThresholdGauge, Timeline, Legend.
Charts · Dashboard primitivesQuick lookup
Direct deep-links into the most-used symbols. The full archive is searchable from any DocC page via the in-archive search bar.
Build it locally
DocC archives can be generated and served locally for offline reading. The repo's GitHub Actions workflow uses the same command.
swiftly run swift package \
--allow-writing-to-directory .build-docs \
generate-documentation \
--target Core \
--target View \
--target TerminalUI \
--target TerminalUICharts \
--enable-experimental-combined-documentation \
--transform-for-static-hosting \
--output-path .build-docs
# Serve locally
swiftly run swift package \
--disable-sandbox \
preview-documentation \
--target TerminalUI