pdf-node

v1.0.1

Published

2 years ago

A JavaScript PDF generation library for NodeJs

Downloads

1,016

pdf-node

A JavaScript PDF generation library for NodeJs

Install

npm install  pdf-node --save

Step 1 - Add required packages and read HTML template

//Required package
var pdf = require("pdf-node");
var fs = require("fs");

// Read HTML Template
var html = fs.readFileSync("template.html", "utf8");

Step 2 - Create your HTML Template

<!DOCTYPE html>
<html>
  <head>
    <mate charest="utf-8" />
    <title>Hello world!</title>
  </head>
  <body>
    <h1>User List</h1>
    <ul>
      {{#each users}}
      <li>Name: {{this.name}}</li>
      <li>Age: {{this.age}}</li>
      <br />
      {{/each}}
    </ul>
  </body>
</html>

Step 3 - Provide format and orientation as per your need

"height": "10.5in", // allowed units: mm, cm, in, px

"width": "8in", // allowed units: mm, cm, in, px

or -

"format": "Letter", // allowed units: A3, A4, A5, Legal, Letter, Tabloid

"orientation": "portrait", // portrait or landscape

    var options = {
        format: "A3",
        orientation: "portrait",
        border: "10mm",
        header: {
            height: "45mm",
            contents: '<div style="text-align: center;">Author: Shyam Hajare</div>'
        },
        footer: {
            height: "28mm",
            contents: {
                first: 'Cover page',
                2: 'Second page', // Any page number is working. 1-based index
                default: '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>', // fallback value
                last: 'Last Page'
            }
        }
    };

Step 4 - Provide HTML, user data and PDF path for output

var users = [
  {
    name: "tom",
    age: "21",
  },
  {
    name: "dick",
    age: "23",
  },
  {
    name: "harry",
    age: "29",
  },
];
var document = {
  html: html,
  data: {
    users: users,
  },
  path: "./output.pdf",
  type: "pdf",
};

Step 5- After setting all parameters, just pass document and options to pdf.create method.

pdf(document, options)
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.error(error);
  });

Reference

Please refer to the following if you want to use conditions in your HTML template:

https://handlebarsjs.com/builtin_helpers.html

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

pdf-node

Install

Reference

Connect