Skip to content

tawseefnabi/pdf-node

Repository files navigation

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>
<title>Hello world!</title>

User List

    {{#each users}}
  • Name: {{this.name}}
  • Age: {{this.age}}

  • {{/each}}
```
  • 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: "alpha",
        age: "21",
      },
      {
        name: "beta",
        age: "23",
      },
      {
        name: "gamma",
        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 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:


Connect

GitHub @tawseefnabi (follow) To stay up to date on free & open-source software

Twitter @NabiTowseef (follow) To get tech updates/small>

LinkedIn @TawseefAhmad (connect) On the LinkedIn profile y'all