# html-pdf > HTML to PDF converter that uses phantomjs Latest version **3.0.1** (published 2021-05-07) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install html-pdf pnpm add html-pdf yarn add html-pdf bun add html-pdf ``` Provides the command `html-pdf`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 3.0.1 | | Published | 2021-05-07 | | First published | 2014-04-18 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/html-pdf) | | Module format | CommonJS | | Node | >=4.0.0 | | Dependencies | 1 | | Unpacked size | 114.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 3578 | | Author | Marc Bachmann | | Maintainers | marcbachmann | | Keywords | html, pdf, phantom, phantomjs, nodejs | ## Links - npm: https://www.npmjs.com/package/html-pdf - Repository: https://github.com/marcbachmann/node-html-pdf - Issues: https://github.com/marcbachmann/node-html-pdf/issues - npm.io page: https://npm.io/package/html-pdf ## Dependencies (1) - [phantomjs-prebuilt](https://npm.io/package/phantomjs-prebuilt.md) ^2.1.16 ## Alternatives - [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads - [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads - [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads - [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads - [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads ## Recent versions - 3.0.1 (latest) — 2021-05-07 - 3.0.0 — 2021-04-20 - 2.2.0 — 2017-09-27 - 2.1.0 — 2016-08-17 - 2.0.1 — 2016-02-19 - 2.0.0 — 2016-02-16 - 1.5.0 — 2016-01-27 - 1.4.0 — 2015-09-06 - 1.3.0 — 2015-08-31 - 1.2.2 — 2015-07-30 - 1.2.1 — 2015-06-14 - 1.2.0 — 2015-04-27 - 1.1.0 — 2015-02-25 - 1.0.0 — 2015-01-25 - 0.3.0 — 2014-11-27 - … 8 more at https://npm.io/package/html-pdf/versions ## README # node-html-pdf ## HTML to PDF converter that uses phantomjs ![image](examples/businesscard/businesscard.png) [Example Business Card](examples/businesscard/businesscard.pdf) -> [and its Source file](examples/businesscard/businesscard.html) [Example Receipt](http://imgr-static.s3-eu-west-1.amazonaws.com/order.pdf) ## Changelog Have a look at the releases page: https://github.com/marcbachmann/node-html-pdf/releases ## Installation Install the html-pdf utility via [npm](http://npmjs.org/): ``` $ npm install -g html-pdf ``` ## Command-line example ``` $ html-pdf test/businesscard.html businesscard.pdf ``` ## Code example ```javascript var fs = require('fs'); var pdf = require('html-pdf'); var html = fs.readFileSync('./test/businesscard.html', 'utf8'); var options = { format: 'Letter' }; pdf.create(html, options).toFile('./businesscard.pdf', function(err, res) { if (err) return console.log(err); console.log(res); // { filename: '/app/businesscard.pdf' } }); ``` ## API ```js var pdf = require('html-pdf'); pdf.create(html).toFile([filepath, ]function(err, res){ console.log(res.filename); }); pdf.create(html).toStream(function(err, stream){ stream.pipe(fs.createWriteStream('./foo.pdf')); }); pdf.create(html).toBuffer(function(err, buffer){ console.log('This is a buffer:', Buffer.isBuffer(buffer)); }); // for backwards compatibility // alias to pdf.create(html[, options]).toBuffer(callback) pdf.create(html [, options], function(err, buffer){}); ``` ### 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. ```html
Header on first page
Header on second page
Header on third page
Header on last page
... ``` ## Options ```javascript config = { // Export options "directory": "/tmp", // The directory the file gets written into if not using .toFile(filename, callback). default: '/tmp' // Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html "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 // Page options "border": "0", // default is 0, units: mm, cm, in, px - or - "border": { "top": "2in", // default is 0, units: mm, cm, in, px "right": "1in", "bottom": "2in", "left": "1.5in" }, paginationOffset: 1, // Override the initial pagination number "header": { "height": "45mm", "contents": '
Author: Marc Bachmann
' }, "footer": { "height": "28mm", "contents": { first: 'Cover page', 2: 'Second page', // Any page number is working. 1-based index default: '{{page}}/{{pages}}', // fallback value last: 'Last Page' } }, // Rendering options "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 // Zooming option, can be used to scale images if `options.type` is not pdf "zoomFactor": "1", // default is 1 // File options "type": "pdf", // allowed file types: png, jpeg, pdf "quality": "75", // only used for types png & jpeg // Script options "phantomPath": "./node_modules/phantomjs/bin/phantomjs", // PhantomJS binary which should get downloaded automatically "phantomArgs": [], // array of strings used as phantomjs args e.g. ["--ignore-ssl-errors=yes"] "localUrlAccess": false, // Prevent local file:// access by passing '--local-url-access=false' to phantomjs // For security reasons you should keep the default value if you render arbritary html/js. "script": '/url', // Absolute path to a custom phantomjs script, use the file in lib/scripts as example "timeout": 30000, // Timeout that will cancel phantomjs, in milliseconds // Time we should wait after window load // accepted values are 'manual', some delay in milliseconds or undefined to wait for a render event "renderDelay": 1000, // HTTP Headers that are used for requests "httpHeaders": { // e.g. "Authorization": "Bearer ACEFAD8C-4B4D-4042-AB30-6C735F5BAC8B" }, // To run Node application as Windows service "childProcessOptions": { "detached": true } // HTTP Cookies that are used for requests "httpCookies": [ // e.g. { "name": "Valid-Cookie-Name", // required "value": "Valid-Cookie-Value", // required "domain": "localhost", "path": "/foo", // required "httponly": true, "secure": false, "expires": (new Date()).getTime() + (1000 * 60 * 60) // e.g. expires in 1 hour } ] } ``` 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. --- _Source: https://npm.io/package/html-pdf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._