A PDF module for the Play framework
Java Scala HTML CSS
Failed to load latest commit information.
example Switched to semantic versioning. Jan 5, 2017
README.md Switched to semantic versioning. Jan 5, 2017



This module helps generating PDF documents dynamically from your Play! web application. It simply renders your HTML- and CSS-based templates to PDF. It is based on the Flying Saucer library, which in turn uses iText for PDF generation.


I have provided a simple example application at https://github.com/benjohnde/play-pdf/tree/master/example.

You can use a standard Play! scala template like this one:

@(message: String)

@main("Welcome to Play 2.5") {
    Image: <img src="/public/images/favicon.png"/><br/>
    Hello world! <br/>
    @message <br/>

Then this template, after having imported de.benjohn.play.pdf.PDF, can simply be rendered as:

public static Result document() {
    return PDF.ok(document.render("Your new application is ready."));

where PDF.ok is a simple shorthand notation for:

ok(PDF.toBytes(document.render("Your new application is ready."))).as("application/pdf")

Template rules

Templates must generate XHTML.

If the template is using an image, stylesheet, etc., it usually is loaded via an http call. The PDF modules tries to optimize that resource loading: If you specify the URI as a path into the classpath of your Play! app, the resource is loaded directly instead. See the above sample template for an example.

Of course you can link to CSS files in your class path also, but be aware not to use the media="screen"qualifier.

Fonts you use must be explicitely packaged with your app.

        body {
            font-family: FreeSans;

The module imports font resources as specified in your application configuration. Specify fonts as follows: pdf.fonts = ["Arial.ttf", "Helvetica.ttf"]. Each font file should be placed in your Play app configuration folder, so that they will be included. See also the example project.


Currently the module is not hosted anywhere. In order to use it, you need to publish it locally in the current play-maven-repository. Therefore:

git clone https://github.com/benjohnde/play-pdf.git
cd play-pdf/module
activator publish-local

Then, add to your libraryDependencies in your build.sbt:

libraryDependencies ++= Seq(
  "de.benjohn.play" %% "pdf" % "1.1.1"

After the next restart of the typesafe-activator, the module should be available. If you are using an IDE like Eclipse, remember to re-generate your project files.