Welcome to node-html-to-image 🌄

> A Node.js library that generates images from HTML

$3

Description

This module exposes a function that generates images (png, jpeg) from HTML. It uses puppeteer in headless mode to achieve it. Additionally, it embarks Handlebars to provide a way to add logic in your HTML.

Install

``sh
npm install node-html-to-image


or


yarn add node-html-to-image
`

Note: When you install Puppeteer, it downloads a recent version of Chromium (~170MB Mac, ~282MB Linux, ~280MB Win) that is guaranteed to work with the API.

Usage

- Simple example
- TypeScript Support
- Options
- Setting output image resolution
- Example with Handlebars
- Using Handlebars helpers
- Dealing with images
- Using the buffer instead of saving to disk
- Generating multiple images
- Using different puppeteer libraries

$3

`js
const nodeHtmlToImage = require('node-html-to-image')

nodeHtmlToImage({
output: './image.png',
html: 'Hello world!'
})
.then(() => console.log('The image was created successfully!'))
`

$3

The library is written in Typescript so it is available out of the box:

`ts
import nodeHtmlToImage from 'node-html-to-image'
`

$3

List of all available options:

| option | description | type | required |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|-------------|
| output | The ouput path for generated image | string | optional |
| html | The html used to generate image content | string | required |
| type | The type of the generated image | jpeg or png (default: png) | optional |
| quality | The quality of the generated image (only applicable to jpg) | number (default: 80) | optional |
| content | If provided html property is considered an handlebars template and use content value to fill it | object or Array | optional |
| waitUntil | Define when to consider markup succeded. Learn more. | string or Array (default: networkidle0) | optional |
| puppeteer | The puppeteer property let you use a different puppeteer library (like puppeteer-core or puppeteer-extra). | object (default: puppeteer) | optional |
| puppeteerArgs | The puppeteerArgs property let you pass down custom configuration to puppeteer. Learn more. | object | optional |
| beforeScreenshot | An async function that will execute just before screenshot is taken. Gives access to puppeteer page element. | Function | optional |
| transparent | The transparent property lets you generate images with transparent background (for png type). | boolean | optional |
| encoding | The encoding property of the image. Options are binary (default) or base64. | string | optional |
| selector | The selector property lets you target a specific element to perform the screenshot on. (default body) | string | optional |
| handlebarsHelpers | The handlebarsHelpers property lets add custom logic to the templates using Handlebars sub-expressions. Learn more. | object | optional |
| timeout | Timeout for a puppeteer-cluster (in ms). Defaults to 30000 (30 seconds). | number | optional |




$3

node-html-to-image takes a screenshot of the body tag's content. If you want to set output image's resolution you need to set its dimension using CSS like in the following example.

`js
const nodeHtmlToImage = require('node-html-to-image')

nodeHtmlToImage({
output: './image.png',
html:



Hello world!


})
.then(() => console.log('The image was created successfully!'))
`

$3

Handlerbars is a templating language. It generates HTML from a template and an input object. In the following example we provide a template to node-html-to-image and a content object to fill the template.

`js
const nodeHtmlToImage = require('node-html-to-image')

nodeHtmlToImage({
output: './image.png',
html: 'Hello {{name}}!',
content: { name: 'you' }
})
.then(() => console.log('The image was created successfully!'))
`

Handlebars provides a lot of expressions to handle common use cases like conditions or loops.




$3

Handlerbars sub-expressions can be used to add custom logic to the templates. To do this, you must pass a handlebarsHelpers object with functions defined within.

For example, if you had a variable and wanted to do some conditional rendering depending on its value, you could do this:

`js
const nodeHtmlToImage = require('node-html-to-image')

nodeHtmlToImage({
output: './image.png',
content: { myVar: 'foo' },
handlebarsHelpers: {
equals: (a, b) => a === b,
},
html:


{{#if (equals myVar 'foo')}}

{{/if}}
{{#if (equals myVar 'bar')}}{{/if}}



})
`

$3

If you want to display an image which is stored remotely do it as usual. In case your image is stored locally I recommend having your image in base64. Then you need to pass it to the template with the content property. Here is an example:

`js
const nodeHtmlToImage = require('node-html-to-image')
const fs = require('fs');

const image = fs.readFileSync('./image.jpg');
const base64Image = new Buffer.from(image).toString('base64');
const dataURI = 'data:image/jpeg;base64,' + base64Image

nodeHtmlToImage({
output: './image.png',
html: '',
content: { imageSource: dataURI }
})
`


$3


If you want to apply fonts, you need to synchronize your parts loading of your website. One way doing it is to convert your font to base64 and add it to your style in your html. For example:
`js
const font2base64 = require('node-font2base64')

const _data = font2base64.encodeToDataUrlSync('../my/awesome/font.ttf')

const html =




...
``

$3

If you don't want to save the image to disk and would rather do something with it immediately, you can use the returned value instead! The example below shows how you can generate an image and send it back to a client via using express.

`js
const express = require('express');
const router = express.Router();
const nodeHtmlToImage = require('node-html-to-image');

router.get(/api/tweet/render, async function(req, res) {
const image = await nodeHtmlToImage({
html: '

'
});
res.writeHead(200, { 'Content-Type': 'image/png' });
res.end(image, 'binary');
});
`

$3

If you want to generate multiple images in one call you must provide an array to the content property.

#### Saving to disk

To save on the disk you must provide the output property on each object in the content property.

`js
nodeHtmlToImage({
html: 'Hello {{name}}!',
content: [{ name: 'Pierre', output: './image1.png' }, { name: 'Paul', output: './image2.png' }, { name: 'Jacques', output: './image3.png' }]
})
.then(() => console.log('The images were created successfully!'))
`

#### Using buffers

If you don't want to save the images to disk you can use the returned value instead. It returns an array of Buffer objects.

`js
const images = await nodeHtmlToImage({
html: 'Hello {{name}}!',
content: [{ name: 'Pierre' }, { name: 'Paul' }, { name: 'Jacques' }]
})
`

$3

If you want to use different puppeteer library you must provide the puppeteer property.

`js
const chrome = require('chrome-aws-lambda');
const nodeHtmlToImage = require('node-html-to-image')
const puppeteerCore = require('puppeteer-core');

const image = await nodeHtmlToImage({
html: '

',
puppeteer: puppeteerCore,
puppeteerArgs: {
args: chromium.args,
executablePath: await chrome.executablePath,
}
})
`

Related

$3

- node-html-to-image-cli - CLI for this module

$3

- Generate images from HTML in Node.js
- node-html-to-image v1.2 is out 🎉

Run tests

`sh
yarn test
``

Author

👤 FRIN Yvonnick

* Website: https://yvonnickfrin.dev
* Twitter: @yvonnickfrin
* Github: @frinyvonnick

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 FRIN Yvonnick .

This project is Apache--2.0 licensed.

*
_This README was generated with ❤️ by readme-md-generator_