Socket
Socket
Sign inDemoInstall

pdf-node-creator

Package Overview
Dependencies
88
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    pdf-node-creator

node pdf creator


Version published
Weekly downloads
70
decreased by-1.41%
Maintainers
1
Install size
9.95 MB
Created
Weekly downloads
 

Readme

Source

Source https://www.npmjs.com/package/pdf-creator-node

Follow these steps to convert HTML to PDF

  • Step 1 - install the pdf creator package using the following command

    $ npm i pdf-creator-node --save

    --save flag adds package name to package.json file.

  • Step 2 - Add required packages and read HTML template

    //Required package
    var pdf = require("pdf-creator-node");
    var fs = require('fs');
    
    // Read HTML Template
    var html = fs.readFileSync('template.html', 'utf8');
    
  • Step 3 - 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>
    

There are some integrated helpers you can use, two to be exact

  1. isdefined - check if data is defined

        <h1>User List</h1>
        <ul>
            {{#each users}}
                {{#if isdefined this}}
                    <li>Name: {{this.name}}</li>
                    <li>Age: {{this.age}}</li>
                {{/if}}
            <br>
        {{/each}}
        </ul>
    
  2. increment - useful for numerating by @index

        <h1>User List</h1>
        <ul>
            {{#each users}}
                <li>User No: {{increment @index}}.</li>
                <li>Name: {{this.name}}</li>
                <li>Age: {{this.age}}</li>
            <br>
        {{/each}}
        </ul>
    
  • Step 4 - 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 5 - Provide HTML, user data and PDF path for output

    var users = [
        {
            name:"Shyam",
            age:"26"
        },
        {
            name:"Navjot",
            age:"26"
        },
        {
            name:"Vitthal",
            age:"26"
        }
    ]
    var document = {
        html: html,
        data: {
            users: users
        },
        path: "./output.pdf"
    };
    
  • Step 6 - After setting all parameters, just pass document and options to pdf.create method.

    pdf.create(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:

End

Keywords

FAQs

Last updated on 28 May 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc