npmpackage.info

Gathering detailed insights and metrics for html-to-image

html-to-image

✂️ Generates an image from a DOM node using HTML5 canvas and SVG.

1.11.11

5,915

MIT

TypeScript

4.98 kB

2.9

Installations

npm install html-to-image

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.16.0

NPM Version

8.11.0 Score

88.5

Supply Chain

100

Quality

76.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

31

Total

157

Closed

55

Merged

71

Issues

Open

116

Total

328

Closed

212

Releases

v1.11.11

Published on 01 Feb 2023

v1.11.10

Published on 01 Feb 2023

v1.11.9

Published on 31 Jan 2023

v1.11.8

Published on 31 Jan 2023

v1.11.7

Published on 30 Jan 2023

v1.11.6

Published on 30 Jan 2023

View all 58 releases

Contributors

View all 39 contributors

Languages

TypeScript

CSS

HTML

JavaScript

Shell

TypeScript (80.89%)

CSS (7.95%)

HTML (7.05%)

JavaScript (3.9%)

Shell (0.21%)

Developer

bubkoo

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

5,915 Stars

413 Commits

561 Forks

31 Watching

4 Branches

39 Contributors

Bundle Size

12.92 kB

Minified

4.98 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.11.11

Package Id

html-to-image@1.11.11

Unpacked Size

292.34 kB

Size

66.12 kB

File Count

NPM Version

8.11.0

Node Version

16.16.0

Publised On

01 Feb 2023

Total Downloads

Cumulative downloads

Total Downloads

0

Last day

Compared to previous day

Last week

Compared to previous week

Last month

Compared to previous month

Last year

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

html-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

1npm install --save html-to-image

Usage

1/* ES6 */
2import * as htmlToImage from 'html-to-image';
3import { toPng, toJpeg, toBlob, toPixelData, toSvg } from 'html-to-image';
4
5/* ES5 */
6var 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:

1var node = document.getElementById('my-node');
2
3htmlToImage.toPng(node)
4  .then(function (dataUrl) {
5    var img = new Image();
6    img.src = dataUrl;
7    document.body.appendChild(img);
8  })
9  .catch(function (error) {
10    console.error('oops, something went wrong!', error);
11  });

Get a PNG image base64-encoded data URL and download it (using download):

1htmlToImage.toPng(document.getElementById('my-node'))
2  .then(function (dataUrl) {
3    download(dataUrl, 'my-node.png');
4  });

toSvg

Get an SVG data URL, but filter out all the <i> elements:

1function filter (node) {
2  return (node.tagName !== 'i');
3}
4
5htmlToImage.toSvg(document.getElementById('my-node'), { filter: filter })
6  .then(function (dataUrl) {
7    /* do something */
8  });

toJpeg

Save and download a compressed JPEG image:

1htmlToImage.toJpeg(document.getElementById('my-node'), { quality: 0.95 })
2  .then(function (dataUrl) {
3    var link = document.createElement('a');
4    link.download = 'my-image-name.jpeg';
5    link.href = dataUrl;
6    link.click();
7  });

toBlob

Get a PNG image blob and download it (using FileSaver):

1htmlToImage.toBlob(document.getElementById('my-node'))
2  .then(function (blob) {
3    if (window.saveAs) {
4      window.saveAs(blob, 'my-node.png');
5    } else {
6     FileSaver.saveAs(blob, 'my-node.png');
7   }
8  });

toCanvas

Get a HTMLCanvasElement, and display it right away:

1htmlToImage.toCanvas(document.getElementById('my-node'))
2  .then(function (canvas) {
3    document.body.appendChild(canvas);
4  });

toPixelData

Get the raw pixel data as a Uint8Array with every 4 array elements representing the RGBA data of a pixel:

1var node = document.getElementById('my-node');
2
3htmlToImage.toPixelData(node)
4  .then(function (pixels) {
5    for (var y = 0; y < node.scrollHeight; ++y) {
6      for (var x = 0; x < node.scrollWidth; ++x) {
7        pixelAtXYOffset = (4 * y * node.scrollHeight) + (4 * x);
8        /* pixelAtXY is a Uint8Array[4] containing RGBA values of the pixel at (x, y) in the range 0..255 */
9        pixelAtXY = pixels.slice(pixelAtXYOffset, pixelAtXYOffset + 4);
10      }
11    }
12  });

React

1import React, { useCallback, useRef } from 'react';
2import { toPng } from 'html-to-image';
3
4const App: React.FC = () => {
5  const ref = useRef<HTMLDivElement>(null)
6
7  const onButtonClick = useCallback(() => {
8    if (ref.current === null) {
9      return
10    }
11
12    toPng(ref.current, { cacheBust: true, })
13      .then((dataUrl) => {
14        const link = document.createElement('a')
15        link.download = 'my-image-name.png'
16        link.href = dataUrl
17        link.click()
18      })
19      .catch((err) => {
20        console.log(err)
21      })
22  }, [ref])
23
24  return (
25    <>
26      <div ref={ref}>
27      {/* DOM nodes you want to convert to PNG */}
28      </div>
29      <button onClick={onButtonClick}>Click me</button>
30    </>
31  )
32}

Options

filter

1(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,

1const filter = (node: HTMLElement) => {
2  const exclusionClasses = ['remove-me', 'secret-div'];
3  return !exclusionClasses.some((classname) => node.classList?.contains(classname));
4}
5
6htmlToImage.toJpeg(node, { quality: 0.95, filter: filter});

1htmlToImage.toPng(node, {filter:filter})

Not called on the root node.

backgroundColor

A string value for the background color, any valid CSS color value.

width, height

Width and height in pixels to be applied to node before rendering.

canvasWidth, canvasHeight

Allows to scale the canva's size including the elements inside to a given width and height (in pixels).

style

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.

quality

A number between 0 and 1 indicating image quality (e.g. 0.92 => 92%) of the JPEG image.

Defaults to 1.0 (100%)

cacheBust

Set to true to append the current time as a query string to URL requests to enable cache busting.

Defaults to false

includeQueryParams

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 false

imagePlaceholder

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.

pixelRatio

The pixel ratio of the captured image. Default use the actual pixel ratio of the device. Set 1 to use as initial-scale 1 for the image.

preferredFontFormat

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:

1@font-face {
2  name: 'proxima-nova';
3  src: url("...") format("woff2"), url("...") format("woff"), url("...") format("opentype");
4}

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.

fontEmbedCSS

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 getFontEmbedCSS() to only perform the embedding process a single time across multiple calls to library functions.

1const fontEmbedCss = await htmlToImage.getFontEmbedCSS(element1);
2html2Image.toSVG(element1, { fontEmbedCss });
3html2Image.toSVG(element2, { fontEmbedCss });

skipAutoScale

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 true and you are exporting a very large image.

Defaults to false

type

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

Browsers

Only standard lib is currently used, but make sure your browser supports:

Promise
SVG <foreignObject> tag

It'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 <foreignObject> 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 <foreignObject> tag. So, in order to render that DOM node for you, following steps are taken:

Clone the original DOM node recursively
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
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 <style> element, then attach it to the clone
Embed images
- embed image URLs in <img> elements
- inline images used in background CSS property, in a fashion similar to fonts
Serialize the cloned node to XML
Wrap XML into the <foreignObject> tag, then into the SVG, then make it a data URL
Optionally, to get PNG content or raw pixel data as a Uint8Array, create an Image element with the SVG as a source, and render it on an off-screen canvas, that you have also created, then read the content from the canvas
Done!

Things to watch out for

If the DOM node you want to render includes a <canvas> element with something drawn on it, it should be handled fine, unless the canvas is tainted - in this case rendering will rather not succeed.
Rendering will failed on huge DOM due to the dataURI limit varies.

Contributing

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our contributing guide.

License

The scripts and documentation in this project are released under the MIT License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/codeql.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/label-commands.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/label-commands.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/label-commands.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/label-commands.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/lock.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/lock.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/needs-more-info.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/needs-more-info.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/needs-more-info.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/needs-more-info.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/potential-duplicates.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/potential-duplicates.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/potential-duplicates.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/potential-duplicates.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-branch-name.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-branch-name.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-branch-name.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-branch-name.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-label-patch-size.yml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-patch-size.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-patch-size.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-patch-size.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-patch-size.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-patch-size.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-status.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-status.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-status.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-status.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-title-body.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-title-body.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-label-title-body.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/pr-label-title-body.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-authors.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-authors.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-authors.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-authors.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-authors.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-authors.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-contributors.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-contributors.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-contributors.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-contributors.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-license.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-license.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-license.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-license.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-license.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/update-license.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/welcome.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/welcome.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/welcome.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bubkoo/html-to-image/welcome.yml/master?enable=pin
Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 31 third-party GitHubAction dependencies pinned

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.9

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

html-to-image

Installations

Developer Guide

Yes

CommonJS

16.16.0

8.11.0

Score

Pull Requests

31

157

55

71

Issues

116

328

212

Releases

Contributors

Languages

Developer

bubkoo

Download Statistics

GitHub Statistics

Bundle Size

12.92 kB

4.98 kB

Maintainers

Package Meta Information

Total Downloads

0

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

html-to-image

Install

Usage

toPng

toSvg

toJpeg

toBlob

toCanvas

toPixelData

React

Options

filter

backgroundColor

width, height

canvasWidth, canvasHeight

style

quality

cacheBust

includeQueryParams

imagePlaceholder

pixelRatio

preferredFontFormat

fontEmbedCSS

skipAutoScale

type

Browsers

How it works

Things to watch out for

Contributing

License

10

10

10

7

0

0

0

0

0

0

0

0

0

2.9