node-html-pdf

This repo isn't maintained anymore as phantomjs got dreprecated a long time...

marcbachmann/node-html-pdfhtml-pdf

README

node-html-pdf

HTML to PDF converter that uses phantomjs

image
Example Business Card
-> and its Source file

Example Receipt

Changelog


Have a look at the releases page: https://github.com/marcbachmann/node-html-pdf/releases

Installation


Install the html-pdf utility via npm:

  1. ```
  2. $ npm install -g html-pdf
  3. ```

Command-line example


  1. ```
  2. $ html-pdf test/businesscard.html businesscard.pdf
  3. ```

Code example

  1. ``` js
  2. var fs = require('fs');
  3. var pdf = require('html-pdf');
  4. var html = fs.readFileSync('./test/businesscard.html', 'utf8');
  5. var options = { format: 'Letter' };

  7. pdf.create(html, options).toFile('./businesscard.pdf', function(err, res) {
  8.   if (err) return console.log(err);
  9.   console.log(res); // { filename: '/app/businesscard.pdf' }
  10. });
  11. ```

API


  1. ``` js
  2. var pdf = require('html-pdf');
  3. pdf.create(html).toFile([filepath, ]function(err, res){
  4.   console.log(res.filename);
  5. });

  7. pdf.create(html).toStream(function(err, stream){
  8.   stream.pipe(fs.createWriteStream('./foo.pdf'));
  9. });

  11. pdf.create(html).toBuffer(function(err, buffer){
  12.   console.log('This is a buffer:', Buffer.isBuffer(buffer));
  13. });


  16. // for backwards compatibility
  17. // alias to pdf.create(html[, options]).toBuffer(callback)
  18. pdf.create(html [, options], function(err, buffer){});
  19. ```

Footers and Headers


html-pdf can read the header or footer either out of the footer and header config object or out of the html source. You can either set a default header & footer or overwrite that by appending a page number (1 based index) to the id="pageHeader" attribute of a html tag.

You can use any combination of those tags. The library tries to find any element, that contains the pageHeader or pageFooter id prefix.
  1. ``` html
  2. <div id="pageHeader">Default header</div>
  3. <div id="pageHeader-first">Header on first page</div>
  4. <div id="pageHeader-2">Header on second page</div>
  5. <div id="pageHeader-3">Header on third page</div>
  6. <div id="pageHeader-last">Header on last page</div>
  7. ...
  8. <div id="pageFooter">Default footer</div>
  9. <div id="pageFooter-first">Footer on first page</div>
  10. <div id="pageFooter-2">Footer on second page</div>
  11. <div id="pageFooter-last">Footer on last page</div>
  12. ```


Options

  1. ``` js
  2. config = {

  4.   // Export options
  5.   "directory": "/tmp",       // The directory the file gets written into if not using .toFile(filename, callback). default: '/tmp'

  7.   // Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html
  8.   "height": "10.5in",        // allowed units: mm, cm, in, px
  9.   "width": "8in",            // allowed units: mm, cm, in, px
  10.   - or -
  11.   "format": "Letter",        // allowed units: A3, A4, A5, Legal, Letter, Tabloid
  12.   "orientation": "portrait", // portrait or landscape

  14.   // Page options
  15.   "border": "0",             // default is 0, units: mm, cm, in, px
  16.   - or -
  17.   "border": {
  18.     "top": "2in",            // default is 0, units: mm, cm, in, px
  19.     "right": "1in",
  20.     "bottom": "2in",
  21.     "left": "1.5in"
  22.   },

  24.   paginationOffset: 1,       // Override the initial pagination number
  25.   "header": {
  26.     "height": "45mm",
  27.     "contents": '<div style="text-align: center;">Author: Marc Bachmann</div>'
  28.   },
  29.   "footer": {
  30.     "height": "28mm",
  31.     "contents": {
  32.       first: 'Cover page',
  33.       2: 'Second page', // Any page number is working. 1-based index
  34.       default: '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>', // fallback value
  35.       last: 'Last Page'
  36.     }
  37.   },


  40.   // Rendering options
  41.   "base": "file:///home/www/your-asset-path/", // Base path that's used to load files (images, css, js) when they aren't referenced using a host

  43.   // Zooming option, can be used to scale images if `options.type` is not pdf
  44.   "zoomFactor": "1", // default is 1

  46.   // File options
  47.   "type": "pdf",           // allowed file types: png, jpeg, pdf
  48.   "quality": "75",         // only used for types png & jpeg

  50.   // Script options
  51.   "phantomPath": "./node_modules/phantomjs/bin/phantomjs", // PhantomJS binary which should get downloaded automatically
  52.   "phantomArgs": [], // array of strings used as phantomjs args e.g. ["--ignore-ssl-errors=yes"]
  53.   "localUrlAccess": false, // Prevent local file:// access by passing '--local-url-access=false' to phantomjs
  54.                            // For security reasons you should keep the default value if you render arbritary html/js.
  55.   "script": '/url',        // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
  56.   "timeout": 30000,        // Timeout that will cancel phantomjs, in milliseconds

  58.   // Time we should wait after window load
  59.   // accepted values are 'manual', some delay in milliseconds or undefined to wait for a render event
  60.   "renderDelay": 1000,

  62.   // HTTP Headers that are used for requests
  63.   "httpHeaders": {
  64.     // e.g.
  65.     "Authorization": "Bearer ACEFAD8C-4B4D-4042-AB30-6C735F5BAC8B"
  66.   },

  68.   // To run Node application as Windows service
  69.   "childProcessOptions": {
  70.     "detached": true
  71.   }

  73.   // HTTP Cookies that are used for requests
  74.   "httpCookies": [
  75.     // e.g.
  76.     {
  77.       "name": "Valid-Cookie-Name", // required
  78.       "value": "Valid-Cookie-Value", // required
  79.       "domain": "localhost",
  80.       "path": "/foo", // required
  81.       "httponly": true,
  82.       "secure": false,
  83.       "expires": (new Date()).getTime() + (1000 * 60 * 60) // e.g. expires in 1 hour
  84.     }
  85.   ]

  87. }
  88. ```

The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.  
There are more options concerning the paperSize, header & footer options inside the phantomjs script.