@pdftron/web-to-pdf

v0.7.0

Published

3 years ago

Headless HTML to PDF conversion

Downloads

0High
0Medium
0Low

pdftron-dev

Web to PDF Converter

Easily create beautiful PDFs using your favorite Javascript and CSS framework!

Created and maintained by PDFTron.

This project is still in development and should not be used in a production environment! It has not been tested in all use cases.

We are very interested in seeing how people use this tool. If you have any questions, comments or would just like to tell us how you're using it, please feel free to open a ticket!

Features

💥 JS is fully supported, meaning you can use your favorite frameworks to generate your PDF.
🔄 Comes with a powerful content replacement system that allows for dynamic content.
🔢 Insert page numbers in your pages dynamically.
💃 Full SCSS support
👸 Support for headers and footers
🔗 Support for reusuable HTML chunks
🎥 Real time mode with hot reloading, meaning you can build your PDF in real time
🌏 Support for rendering remote pages (You can even inject your own css and js!)
🚦 Queueing system so you can render 1000's of PDFs with a single script.
👍 Much more!

Roadmap

Examples (external repos?) of usage with other frameworks
Splitting of non-list content on page break
Support for form inputs

Installation

npm i @pdftron/web-to-pdf

Example

const Renderer = require('@pdftron/web-to-pdf');

const r = new Renderer({ dirname: __dirname });

const htmlString = `
  <html>
    <head>
      <link rel='stylesheet' href='style.scss'>
    </head>
    <body>
      <div class='Page'>
        Page1: {{myText}}
      </div>

      <div class='Page'>
        Page2: Goodbye world!
      </div>
    </body>
  </html>
`;

r.render({
  templateSource: htmlString,
  contentSource: {
    myText: "Hello world!"
  },
  outputName: 'example'
});

// Pdf will be rendered at ./outputs/example.pdf !

See more examples here.

Documentation

Real time PDF Building

With a few changes to your options you can enable real time PDF building! See the docs for more info.

Development

git clone https://github.com/PDFTron/web-to-pdf.git
cd web-to-pdf
npm i

There are examples you can test on in the examples folder. These examples are run via scripts in package.json

Contributing

Before created a PR, please make sure tests pass:

npm run test

If you would like to contribute but aren't sure how, please open a ticket saying you would like to contribute.

Feel free to add tests you feel needed.

Caveats

Creation of PDF input fields is not supported (not supported by chromium).

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme