html-to-image
v1.11.13TypeScript
Generates an image from a DOM node using HTML5 canvas and SVG.
1.7M/weekUpdated 9 months agoMITUnpacked: 315.1 KB
Published by bubkooo
npm install html-to-imagehtml-to-image
✂️ Generates an image from a DOM node using HTML5 canvas and SVG.
Fork from dom-to-image with more maintainable code and some new features.
Install
``shell`
npm install --save html-to-image
Usage
`js
/ ES6 /
import * as htmlToImage from 'html-to-image';
import { toPng, toJpeg, toBlob, toPixelData, toSvg } from 'html-to-image';
/ ES5 /
var htmlToImage = require('html-to-image');
`
All the top level functions accept DOM node and rendering options, and return a promise fulfilled with corresponding dataURL:
- toPng
- toSvg
- toJpeg
- toBlob
- toCanvas
- toPixelData
Go with the following examples.
#### toPng
Get a PNG image base64-encoded data URL and display it right away:
`js
const node = document.getElementById('my-node');
htmlToImage
.toPng(node)
.then((dataUrl) => {
const img = new Image();
img.src = dataUrl;
document.body.appendChild(img);
})
.catch((err) => {
console.error('oops, something went wrong!', err);
});
`
Get a PNG image base64-encoded data URL and download it (using download):
`js`
htmlToImage
.toPng(document.getElementById('my-node'))
.then((dataUrl) => download(dataUrl, 'my-node.png'));
#### toSvg
Get an SVG data URL, but filter out all the elements:
`js
function filter (node) {
return (node.tagName !== 'i');
}
htmlToImage
.toSvg(document.getElementById('my-node'), { filter: filter })
.then(function (dataUrl) {
/ do something /
});
`
#### toJpeg
Save and download a compressed JPEG image:
`js`
htmlToImage
.toJpeg(document.getElementById('my-node'), { quality: 0.95 })
.then(function (dataUrl) {
var link = document.createElement('a');
link.download = 'my-image-name.jpeg';
link.href = dataUrl;
link.click();
});
#### toBlob
Get a PNG image blob and download it (using FileSaver):
`js`
htmlToImage
.toBlob(document.getElementById('my-node'))
.then(function (blob) {
if (window.saveAs) {
window.saveAs(blob, 'my-node.png');
} else {
FileSaver.saveAs(blob, 'my-node.png');
}
});
#### toCanvas
Get a HTMLCanvasElement, and display it right away:
`js`
htmlToImage
.toCanvas(document.getElementById('my-node'))
.then(function (canvas) {
document.body.appendChild(canvas);
});
#### toPixelData
Get the raw pixel data as a Uint8Array with every 4 array elements representing the RGBA data of a pixel:
`js
var node = document.getElementById('my-node');
htmlToImage
.toPixelData(node)
.then(function (pixels) {
for (var y = 0; y < node.scrollHeight; ++y) {
for (var x = 0; x < node.scrollWidth; ++x) {
pixelAtXYOffset = (4 y node.scrollHeight) + (4 * x);
/ pixelAtXY is a Uint8Array[4] containing RGBA values of the pixel at (x, y) in the range 0..255 /
pixelAtXY = pixels.slice(pixelAtXYOffset, pixelAtXYOffset + 4);
}
}
});
`
#### React
`tsx
import React, { useCallback, useRef } from 'react';
import { toPng } from 'html-to-image';
const App: React.FC = () => {
const ref = useRef
const onButtonClick = useCallback(() => {
if (ref.current === null) {
return
}
toPng(ref.current, { cacheBust: true, })
.then((dataUrl) => {
const link = document.createElement('a')
link.download = 'my-image-name.png'
link.href = dataUrl
link.click()
})
.catch((err) => {
console.log(err)
})
}, [ref])
return (
<>
{/ DOM nodes you want to convert to PNG /}
)
}
`
Options
$3
ts
(domNode: HTMLElement) => boolean
`A function taking DOM node as argument. Should return true if passed node should be included in the output. Excluding node means excluding it's children as well.
You can add filter to every image function. For example,
ts
const filter = (node: HTMLElement) => {
const exclusionClasses = ['remove-me', 'secret-div'];
return !exclusionClasses.some((classname) => node.classList?.contains(classname));
}htmlToImage.toJpeg(node, { quality: 0.95, filter: filter});
`
orjs
htmlToImage.toPng(node, {filter:filter})
`Not called on the root node.
$3
A string value for the background color, any valid CSS color value.
$3
Width and height in pixels to be applied to node before rendering.
$3
Allows to scale the canva's size including the elements inside to a given width and height (in pixels).
$3
An object whose properties to be copied to node's style before rendering. You might want to check this reference for JavaScript names of CSS properties.
$3
A number between
and 1 indicating image quality (e.g. 0.92 => 92%) of the JPEG image.Defaults to
1.0 (100%)$3
Set to true to append the current time as a query string to URL requests to enable cache busting.
Defaults to
false$3
Set false to use all URL as cache key.
If the value has falsy value, it will exclude query params from the provided URL.
Defaults to
$3
A data URL for a placeholder image that will be used when fetching an image fails.
Defaults to an empty string and will render empty areas for failed images.
$3
The pixel ratio of the captured image. Default use the actual pixel ratio of the device. Set
to
use as initial-scale 1 for the image.$3
The format required for font embedding. This is a useful optimisation when a webfont provider
specifies several different formats for fonts in the CSS, for example:
`css
@font-face {
name: 'proxima-nova';
src: url("...") format("woff2"), url("...") format("woff"), url("...") format("opentype");
}
`Instead of embedding each format, all formats other than the one specified will be discarded. If
this option is not specified then all formats will be downloaded and embedded.
$3
When supplied, the library will skip the process of parsing and embedding webfont URLs in CSS,
instead using this value. This is useful when combined with
to only perform the
embedding process a single time across multiple calls to library functions.`javascript
const fontEmbedCSS = await htmlToImage.getFontEmbedCSS(element1);
html2Image.toSVG(element1, { fontEmbedCSS });
html2Image.toSVG(element2, { fontEmbedCSS });
`$3
When supplied, the library will skip the process of scaling extra large doms into the canvas object.
You may experience loss of parts of the image if set to
and you are exporting a very large image.Defaults to
false $3
A string indicating the image format. The default type is image/png; that type is also used if the given type isn't supported.
When supplied, the toCanvas function will return a blob matching the given image type and quality.
Defaults to
image/png$3
An array of style property names. Can be used to manually specify which style properties are included when cloning nodes. This can be useful for performance-critical scenarios.
Browsers
Only standard lib is currently used, but make sure your browser supports:
- Promise
- SVG
tagIt's tested on latest Chrome, Firefox and Safari (49, 45 and 16 respectively at the time of writing), with Chrome performing significantly better on big DOM trees, possibly due to it's more performant SVG support, and the fact that it supports
CSSStyleDeclaration.cssText property.Internet Explorer is not (and will not be) supported, as it does not support SVG
tag.How it works
There might some day exist (or maybe already exists?) a simple and standard way of exporting parts of the HTML to image (and then this script can only serve as an evidence of all the hoops I had to jump through in order to get such obvious thing done) but I haven't found one so far.
This library uses a feature of SVG that allows having arbitrary HTML content inside of the
tag. So, in order to render that DOM node for you, following steps are taken:1. Clone the original DOM node recursively
2. Compute the style for the node and each sub-node and copy it to corresponding clone
- and don't forget to recreate pseudo-elements, as they are not cloned in any way, of course
3. Embed web fonts
- find all the
@font-face declarations that might represent web fonts
- parse file URLs, download corresponding files
- base64-encode and inline content as dataURLs
- concatenate all the processed CSS rules and put them into one