pdf generator README

cmp-pdf-generator

Cross-platform PDF generation library — published as part of kmp-toolkit.

Module README + cookbook + ADRs live at /cmp-pdf-generator/.

In a nutshell

val generator = createPdfGenerator(context)  // Android — or PdfGenerator() elsewhere
val doc = pdf {
    branding(PdfBranding.default())
    page {
        heading(1, "Hello")
        text("World")
    }
}
val result = generator.generate(doc, PdfOutput.Share)

Three input modes

1. HTML — generateFromHtml(html, output) — pixel-perfect when fidelity matters
2. Markdown — MarkdownPdfAdapter.markdownToHtml(md, branding) → generateFromHtml
3. DSL — pdf { page { … } } — programmatic, type-safe, no HTML

Six output destinations

PdfOutput.File, .ByteArrayOutput, .Uri(callback), .Share, .Print, .Save.

Five pre-built templates

InvoiceTemplate, ReportTemplate, ReceiptTemplate, StatementTemplate, LetterTemplate.

Platform support

Platform	Engine
Android	WebView + PrintManager / native PdfDocument
iOS 14+	WKWebView.createPDF / PDFKit
macOS 11+	WKWebView.createPDF / PDFKit
JVM	OpenHTMLToPDF / Apache PDFBox
JS (browser+Node)	iframe+print / pdf-lib
wasmJs (browser+Node)	iframe+print / pdf-lib

Not targeted: tvOS, watchOS, Linux native, mingwX64, wasmWasi — upstream library coverage is incomplete on those.

Links

• Full README
• SPEC — design intent
• API — public symbols
• ADRs — engine choice, branding, error model, tiers, DSL shape
• Cookbook — invoice, receipt, markdown, DSL, image, composable
• Migration from mifos-x