---

This library is in the middle of having Chrome support added to it, so the readme is currently out-of-date. If you'd like a functioning library and can deal with only having WkHTMLtoPDF support then checkout the version 1.1.0 tag.

---

html-to-pdf-converter

A library for converting HTML documents to PDF documents with support for either Chrome DevTools or WkHTMLtoPDF.

Using Chrome

This library wraps and simplifies usage of the chrome-devtools-java-client library so interacting with a running Chrome instance is safe and easy. Provided that ......., a valid request to your running Chrome instance might look like the following:

ChromeHtmlToPdfConverter converter = ...
String html = ...
File outputFile = ...

try (InMemoryPDF pdf = converter.tryToConvert(html)) {
    try(OutputStream out = Files.newOutputStream(outputFile.toPath())) {
        pdf.write(out);
    }   
}

TODO: More documentation here

Using WkHTMLtoPDF binary

Disclaimer: This PDF conversion strategy should only be used when connecting to a running Chrome service isn't feasible. The underlying binary is no longer being actively developed and will likely break if the page being converted is using newer technologies (e.g. flexbox).

This library uses a binary of WkHTMLtoPDF, Apache Exec, and synchronization for a robust, thread-safe HTML to PDF conversion process.

It includes the binaries for Windows, Mac & Linux and will decide which to use based on the current operating system.
Optionally you can provide your own wkhtmltopdf binary by setting the WKHTMLTOPDF_BINARY environment variable.

Limitations

This library aims at simplifying the usage of wkhtmltopdf in Java, which means this library is limited to only what that tool can do and also shares any bugs that tool might contain.

This library is written and compiled with Java 8. Compile from source if you need to target a lower Java version.

Adding this to your project

In your build.gradle file:

• Under repositories
  • Add maven { url "https://jitpack.io" }, making sure it's the last repo declared
• Under dependencies
  • Add compile 'com.github.todd-elvers:html-to-pdf-converter:1.1.0'

Examples:

In the following example we write the resulting PDF to a temporary directory, then write it to some stream, and then the try-with-resources block cleans up the PDF from disk:

HtmlToPdfFileConverter htmlToPdfFileConverter = new HtmlToPdfFileConverter();

try (PdfFile pdfFile = htmlToPdfFileConverter.tryToConvert(html)) {
    pdfFile.writeToOutputStream(...);
}

If you want to avoid the intermediate step of writing to a temporary directory and instead write directly to the destination:

HtmlToPdfFileConverter htmlToPdfFileConverter = new HtmlToPdfFileConverter();
File outputFile = ...

try {
    htmlToPdfFileConverter.tryToConvert(html, outputFile);
} catch(HtmlToPdfConversionException ex) {
    ...
}