Generate PDFs from Compose UI with multi-page and dynamic page support, configurable page sizes and filenames, customizable output directory, automatic initialization, and simple sharing integration.
Generate PDF documents from Compose UI on Android, iOS, and Desktop.
| Platform | Status | Notes |
|---|---|---|
| Android | ✅ Supported | API 26+ (Android 8.0+) |
| iOS | ✅ Supported | iOS 14.0+ (iosArm64, iosX64, iosSimulatorArm64) |
| Desktop (JVM) | ✅ Supported | JVM 17+ (macOS, Windows, Linux) |
| WASM | 🚧 Planned | Coming soon |
commonMain {
dependencies {
implementation("io.github.big-jared:kmpdf:1.0.0")
}
}val generator = createKmPdfGenerator()
val result = generator.generatePdf(
config = PdfConfig(
pageSize = PageSize.Letter,
fileName = "my-document.pdf"
)
) {
page {
Text("Hello, PDF!")
}
page {
Text("Page 2 content")
}
}
when (result) {
is PdfResult.Success -> sharePdf(result.uri)
is PdfResult.Error -> println(result.message)
}generator.generatePdf(
config = PdfConfig(
pageSize = PageSize.A4,
fileName = "document.pdf"
)
) {
page {
Column(Modifier.fillMaxSize().padding(24.dp)) {
Text("My Document", style = MaterialTheme.typography.headlineLarge)
Spacer(Modifier.height(16.dp))
Text("Content goes here")
}
}
}generator.generatePdf(
config = PdfConfig(fileName = "multi-page.pdf")
) {
page {
Text("Page 1")
}
page {
Text("Page 2")
}
page {
Text("Page 3")
}
}Use loops or any Kotlin logic to create pages from data:
generator.generatePdf(
config = PdfConfig(fileName = "report.pdf")
) {
items.forEach { item ->
page {
ItemContent(item)
}
}
}PdfConfig(
pageSize = PageSize.A4, // A4, Letter, Legal, A3, A5, Tabloid
fileName = "report.pdf", // Output filename
outputDirectory = "/custom/path" // Optional, Desktop only (defaults to ~/Documents/pdfs/)
)PageSize.A4 - 210mm × 297mm (default)PageSize.Letter - 8.5" × 11"PageSize.Legal - 8.5" × 14"PageSize.A3 - 297mm × 420mmPageSize.A5 - 148mm × 210mmPageSize.Tabloid - 11" × 17"Initialization: KmPDF initializes automatically via ContentProvider. No manual setup required.
Add FileProvider to your app's AndroidManifest.xml for sharing PDFs:
<application>
<provider
android:name="androidx.core.content.FileProvider"
android:authorities="${applicationId}.fileprovider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
</application>Create res/xml/file_paths.xml:
<?xml version="1.0" encoding="utf-8"?>
<paths>
<cache-path name="pdfs" path="pdfs/" />
</paths>No additional setup required.
PDFs are saved to ~/Documents/pdfs/ by default. You can specify a custom output directory using the outputDirectory parameter in PdfConfig.
when (result) {
is PdfResult.Success -> {
println("PDF: ${result.filePath}")
println("${result.pageCount} pages, ${result.fileSize} bytes")
}
is PdfResult.Error -> {
println("Error: ${result.message}")
}
}MIT License - Copyright (c) 2025 Jared Guttromson
See LICENSE for full details.
Generate PDF documents from Compose UI on Android, iOS, and Desktop.
| Platform | Status | Notes |
|---|---|---|
| Android | ✅ Supported | API 26+ (Android 8.0+) |
| iOS | ✅ Supported | iOS 14.0+ (iosArm64, iosX64, iosSimulatorArm64) |
| Desktop (JVM) | ✅ Supported | JVM 17+ (macOS, Windows, Linux) |
| WASM | 🚧 Planned | Coming soon |
commonMain {
dependencies {
implementation("io.github.big-jared:kmpdf:1.0.0")
}
}val generator = createKmPdfGenerator()
val result = generator.generatePdf(
config = PdfConfig(
pageSize = PageSize.Letter,
fileName = "my-document.pdf"
)
) {
page {
Text("Hello, PDF!")
}
page {
Text("Page 2 content")
}
}
when (result) {
is PdfResult.Success -> sharePdf(result.uri)
is PdfResult.Error -> println(result.message)
}generator.generatePdf(
config = PdfConfig(
pageSize = PageSize.A4,
fileName = "document.pdf"
)
) {
page {
Column(Modifier.fillMaxSize().padding(24.dp)) {
Text("My Document", style = MaterialTheme.typography.headlineLarge)
Spacer(Modifier.height(16.dp))
Text("Content goes here")
}
}
}generator.generatePdf(
config = PdfConfig(fileName = "multi-page.pdf")
) {
page {
Text("Page 1")
}
page {
Text("Page 2")
}
page {
Text("Page 3")
}
}Use loops or any Kotlin logic to create pages from data:
generator.generatePdf(
config = PdfConfig(fileName = "report.pdf")
) {
items.forEach { item ->
page {
ItemContent(item)
}
}
}PdfConfig(
pageSize = PageSize.A4, // A4, Letter, Legal, A3, A5, Tabloid
fileName = "report.pdf", // Output filename
outputDirectory = "/custom/path" // Optional, Desktop only (defaults to ~/Documents/pdfs/)
)PageSize.A4 - 210mm × 297mm (default)PageSize.Letter - 8.5" × 11"PageSize.Legal - 8.5" × 14"PageSize.A3 - 297mm × 420mmPageSize.A5 - 148mm × 210mmPageSize.Tabloid - 11" × 17"Initialization: KmPDF initializes automatically via ContentProvider. No manual setup required.
Add FileProvider to your app's AndroidManifest.xml for sharing PDFs:
<application>
<provider
android:name="androidx.core.content.FileProvider"
android:authorities="${applicationId}.fileprovider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
</application>Create res/xml/file_paths.xml:
<?xml version="1.0" encoding="utf-8"?>
<paths>
<cache-path name="pdfs" path="pdfs/" />
</paths>No additional setup required.
PDFs are saved to ~/Documents/pdfs/ by default. You can specify a custom output directory using the outputDirectory parameter in PdfConfig.
when (result) {
is PdfResult.Success -> {
println("PDF: ${result.filePath}")
println("${result.pageCount} pages, ${result.fileSize} bytes")
}
is PdfResult.Error -> {
println("Error: ${result.message}")
}
}MIT License - Copyright (c) 2025 Jared Guttromson
See LICENSE for full details.