{"maintainers":[{"name":"anonymous","email":"bubkoo.wy@gmail.com"}],"keywords":["screenshot","capture","canvas","html","dom","image","vector","svg"],"dist-tags":{"latest":"1.11.13"},"author":{"name":"bubkooo","email":"bubkoo.wy@gmail.com"},"description":"Generates an image from a DOM node using HTML5 canvas and SVG.","readme":"

html-to-image

\n\n

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

\n\n

Fork from dom-to-image with more maintainable code and some new features.

\n\n

\n\"build\"\n\"coverage\"\n\"NPM\n\"NPM\n\n\n

\n\n

\n\"MIT\n\"Language\"\n\"PRs\n

\n\n## Install\n\n```shell\nnpm install --save html-to-image\n```\n\n## Usage\n\n```js\n/* ES6 */\nimport * as htmlToImage from 'html-to-image';\nimport { toPng, toJpeg, toBlob, toPixelData, toSvg } from 'html-to-image';\n\n/* ES5 */\nvar htmlToImage = require('html-to-image');\n```\n\nAll the top level functions accept DOM node and rendering options, and return a promise fulfilled with corresponding dataURL:\n\n- [toPng](#toPng)\n- [toSvg](#toSvg)\n- [toJpeg](#toJpeg)\n- [toBlob](#toBlob)\n- [toCanvas](#toCanvas)\n- [toPixelData](#toPixelData)\n\nGo with the following examples.\n\n#### toPng\nGet a PNG image base64-encoded data URL and display it right away:\n\n```js\nconst node = document.getElementById('my-node');\n\nhtmlToImage\n .toPng(node)\n .then((dataUrl) => {\n const img = new Image();\n img.src = dataUrl;\n document.body.appendChild(img);\n })\n .catch((err) => {\n console.error('oops, something went wrong!', err);\n });\n```\n\nGet a PNG image base64-encoded data URL and download it (using [download](https://github.com/rndme/download)):\n\n```js\nhtmlToImage\n .toPng(document.getElementById('my-node'))\n .then((dataUrl) => download(dataUrl, 'my-node.png'));\n```\n\n#### toSvg\nGet an SVG data URL, but filter out all the `` elements:\n\n```js\nfunction filter (node) {\n return (node.tagName !== 'i');\n}\n\nhtmlToImage\n .toSvg(document.getElementById('my-node'), { filter: filter })\n .then(function (dataUrl) {\n /* do something */\n });\n```\n\n#### toJpeg\nSave and download a compressed JPEG image:\n\n```js\nhtmlToImage\n .toJpeg(document.getElementById('my-node'), { quality: 0.95 })\n .then(function (dataUrl) {\n var link = document.createElement('a');\n link.download = 'my-image-name.jpeg';\n link.href = dataUrl;\n link.click();\n });\n```\n\n#### toBlob\nGet a PNG image blob and download it (using [FileSaver](https://github.com/eligrey/FileSaver.js)):\n\n```js\nhtmlToImage\n .toBlob(document.getElementById('my-node'))\n .then(function (blob) {\n if (window.saveAs) {\n window.saveAs(blob, 'my-node.png');\n } else {\n FileSaver.saveAs(blob, 'my-node.png');\n }\n });\n```\n\n#### toCanvas\nGet a HTMLCanvasElement, and display it right away:\n\n```js\nhtmlToImage\n .toCanvas(document.getElementById('my-node'))\n .then(function (canvas) {\n document.body.appendChild(canvas);\n });\n```\n\n#### toPixelData\nGet the raw pixel data as a [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) with every 4 array elements representing the RGBA data of a pixel:\n\n```js\nvar node = document.getElementById('my-node');\n\nhtmlToImage\n .toPixelData(node)\n .then(function (pixels) {\n for (var y = 0; y < node.scrollHeight; ++y) {\n for (var x = 0; x < node.scrollWidth; ++x) {\n pixelAtXYOffset = (4 * y * node.scrollHeight) + (4 * x);\n /* pixelAtXY is a Uint8Array[4] containing RGBA values of the pixel at (x, y) in the range 0..255 */\n pixelAtXY = pixels.slice(pixelAtXYOffset, pixelAtXYOffset + 4);\n }\n }\n });\n```\n\n#### React\n```tsx\nimport React, { useCallback, useRef } from 'react';\nimport { toPng } from 'html-to-image';\n\nconst App: React.FC = () => {\n const ref = useRef(null)\n\n const onButtonClick = useCallback(() => {\n if (ref.current === null) {\n return\n }\n\n toPng(ref.current, { cacheBust: true, })\n .then((dataUrl) => {\n const link = document.createElement('a')\n link.download = 'my-image-name.png'\n link.href = dataUrl\n link.click()\n })\n .catch((err) => {\n console.log(err)\n })\n }, [ref])\n\n return (\n <>\n
\n {/* DOM nodes you want to convert to PNG */}\n
\n \n \n )\n}\n```\n\n## Options\n\n### filter\n\n```ts\n(domNode: HTMLElement) => boolean\n```\n\nA 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.\n\nYou can add filter to every image function. For example, \n\n```ts\nconst filter = (node: HTMLElement) => {\n const exclusionClasses = ['remove-me', 'secret-div'];\n return !exclusionClasses.some((classname) => node.classList?.contains(classname));\n}\n\nhtmlToImage.toJpeg(node, { quality: 0.95, filter: filter});\n```\nor\n\n```js\nhtmlToImage.toPng(node, {filter:filter})\n```\n\nNot called on the root node.\n\n### backgroundColor\n\nA string value for the background color, any valid CSS color value.\n\n### width, height\n\nWidth and height in pixels to be applied to node before rendering.\n\n### canvasWidth, canvasHeight\n\nAllows to scale the canva's size including the elements inside to a given width and height (in pixels).\n\n### style\n\nAn object whose properties to be copied to node's style before rendering. You might want to check [this reference](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Properties_Reference) for JavaScript names of CSS properties.\n\n### quality\n\nA number between `0` and `1` indicating image quality (e.g. `0.92` => `92%`) of the JPEG image.\n\nDefaults to `1.0` (`100%`)\n\n### cacheBust\n\nSet to true to append the current time as a query string to URL requests to enable cache busting.\n\nDefaults to `false`\n\n### includeQueryParams\n\nSet false to use all URL as cache key.\nIf the value has falsy value, it will exclude query params from the provided URL.\n\nDefaults to `false`\n\n### imagePlaceholder\n\nA data URL for a placeholder image that will be used when fetching an image fails.\n\nDefaults to an empty string and will render empty areas for failed images.\n\n### pixelRatio\n\nThe pixel ratio of the captured image. Default use the actual pixel ratio of the device. Set `1` to\nuse as initial-scale `1` for the image.\n\n### preferredFontFormat\n\nThe format required for font embedding. This is a useful optimisation when a webfont provider\nspecifies several different formats for fonts in the CSS, for example:\n\n```css\n@font-face {\n name: 'proxima-nova';\n src: url(\"...\") format(\"woff2\"), url(\"...\") format(\"woff\"), url(\"...\") format(\"opentype\");\n}\n```\n\nInstead of embedding each format, all formats other than the one specified will be discarded. If\nthis option is not specified then all formats will be downloaded and embedded.\n\n### fontEmbedCSS\n\nWhen supplied, the library will skip the process of parsing and embedding webfont URLs in CSS,\ninstead using this value. This is useful when combined with `getFontEmbedCSS()` to only perform the\nembedding process a single time across multiple calls to library functions.\n\n```javascript\nconst fontEmbedCSS = await htmlToImage.getFontEmbedCSS(element1);\nhtml2Image.toSVG(element1, { fontEmbedCSS });\nhtml2Image.toSVG(element2, { fontEmbedCSS });\n```\n\n### skipAutoScale\n\nWhen supplied, the library will skip the process of scaling extra large doms into the canvas object.\nYou may experience loss of parts of the image if set to `true` and you are exporting a very large image.\n\nDefaults to `false` \n\n### type\n\nA string indicating the image format. The default type is image/png; that type is also used if the given type isn't supported.\nWhen supplied, the toCanvas function will return a blob matching the given image type and quality. \n\nDefaults to `image/png`\n\n### includeStyleProperties\n\nAn 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.\n\n## Browsers\n\nOnly standard lib is currently used, but make sure your browser supports:\n\n- [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)\n- SVG `` tag\n\nIt'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.\n\n*Internet Explorer is not (and will not be) supported, as it does not support SVG `` tag.*\n\n## How it works\n\nThere 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.\n\nThis 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:\n\n1. Clone the original DOM node recursively\n2. Compute the style for the node and each sub-node and copy it to corresponding clone \n - and don't forget to recreate pseudo-elements, as they are not cloned in any way, of course\n3. Embed web fonts\n - find all the `@font-face` declarations that might represent web fonts\n - parse file URLs, download corresponding files\n - base64-encode and inline content as dataURLs\n - concatenate all the processed CSS rules and put them into one `