Skip to content

openpdf-kotlin

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

openpdf-kotlin

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src/main
src/main
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

OpenPDF-Kotlin

OpenPDF Kotlin is a Kotlin extension module for OpenPDF. It provides Kotlin APIs, utilities, and builder-style functionality for working with PDF documents.

This submodule makes OpenPDF more convenient and expressive for Kotlin developers by offering:

  • Extension functions for common PDF tasks
  • A lightweight Kotlin-style PdfBuilder for creating PDF files in Kotlin.
  • HtmlPdfBuilder for creating PDF files from HTML.
  • DSL-inspired document generation syntax

Kotlin pull requests are welcome!

Kotlin based OpenPDF projects!

Example Usage

Make PDF file from HTML:

import java.io.FileOutputStream
import com.github.librepdf.html.HtmlPdfBuilder
import org.openpdf.text.pdf.PdfWriter

val outputStream = FileOutputStream("output.pdf")

HtmlPdfBuilder(outputStream).apply {
    html(
        """
        <html>
          <head><title>Example</title></head>
          <body>
            <h1>Hello from HTML</h1>
            <p>This PDF was generated using openpdf-html and Kotlin.</p>
          </body>
        </html>
        """.trimIndent()
    )
    scaleToFit(true)
    pdfVersion(org.openpdf.text.pdf.PdfWriter.VERSION_1_7)
    build()
}

Make PDF file using Kotlin code:

import com.github.librepdf.kotlin.PdfBuilder
import java.io.FileOutputStream

fun main() {
    FileOutputStream("example.pdf").use { output ->
        PdfBuilder(output).build {
            title("Hello from Kotlin")
            subtitle("Using OpenPDF Kotlin")
            paragraph("This is a paragraph in a PDF file.")
            image("logo.png", scalePercent = 50f)
        }
    }
}

TODO

  • Allow using Openpdf-html and Openpdf-renderer in Kotlin, create Kotlin utility classes and Kotlin examples of using OpenPDF to create PDF files from HTML (Openpdf-html), and to render PDF files as images (Openpdf-renderer).
  • Add unit tests for all Kotlin utilities
  • Add PdfFormUtil for working with AcroForms (fill/read fields)
  • Create PdfMetadataUtil for reading document properties
  • Write more Kotlin usage examples and tutorials
  • Explore multiplatform or Android compatibility
  • Set up markdownlint and Kotlin style linter