html-to-image - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "html-to-image",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Generates an image from a DOM node using HTML5 canvas.",
-  "main": "index.js",
+  "main": "./lib/index.js",
+  "files": [
+    "lib",
+    "src"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "cross-env NODE_ENV=test nyc mocha ./test/index.js",
+    "coveralls": "nyc report --reporter=text-lcov | coveralls",
+    "lint": "eslint --ext .js,.jsx src",
+    "build": "rimraf lib && babel src --out-dir lib",
+    "prebuild": "npm run lint",
+    "prepublish": "npm run build",
+    "precommit": "npm run lint"
   },
@@ -14,2 +24,3 @@ "repository": {
   "keywords": [
+    "screenshot",
     "cavas",
@@ -28,3 +39,27 @@ "html",
   },
-  "homepage": "https://github.com/bubkoo/html-to-image#readme"
-}
+  "homepage": "https://github.com/bubkoo/html-to-image#readme",
+  "devDependencies": {
+    "babel-cli": "^6.26.0",
+    "babel-eslint": "^8.0.3",
+    "babel-plugin-add-module-exports": "^0.2.1",
+    "babel-plugin-istanbul": "^4.1.5",
+    "babel-plugin-transform-decorators-legacy": "^1.3.4",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-env": "^1.6.1",
+    "babel-preset-react": "^6.24.1",
+    "babel-preset-stage-0": "^6.24.1",
+    "babel-register": "^6.26.0",
+    "chai": "^4.1.2",
+    "coveralls": "^3.0.0",
+    "cross-env": "^5.1.1",
+    "eslint": "^4.12.1",
+    "eslint-config-airbnb": "^16.1.0",
+    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-jsx-a11y": "^6.0.2",
+    "eslint-plugin-react": "^7.5.1",
+    "husky": "^0.14.3",
+    "mocha": "^4.0.1",
+    "nyc": "^11.3.0",
+    "rimraf": "^2.6.2"
+  }
+}

README.md

 # html-to-image
 
-> Generates an image from a DOM node using HTML5 canvas.
+> A pure JavaScript library which can turn arbitrary DOM node into a vector (SVG) or raster (PNG or JPEG) images. Fork from [dom-to-image](https://github.com/tsayen/dom-to-image) with more maintainable code and some new features.
+
+## Install 
+
+```shell
+npm install --save html-to-image
+```
+
+## Usage
+
+```js
+/* ES6 */
+import htmlToImage 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
+- toJpeg
+- toBlob
+- toPixelData
+- toSvgDataURL
+
+Go with the following examples.
+
+Get a PNG image base64-encoded data URL and display it right away:
+
+```js
+var node = document.getElementById('my-node');
+
+htmlToImage.toPng(node)
+  .then(function (dataUrl) {
+    var img = new Image();
+    img.src = dataUrl;
+    document.body.appendChild(img);
+  })
+  .catch(function (error) {
+    console.error('oops, something went wrong!', error);
+  });
+```
+
+Get a PNG image base64-encoded data URL and download it (using [download](https://github.com/rndme/download)):
+
+```js
+htmlToImage.toPng(document.getElementById('my-node'))
+  .then(function (dataUrl) {
+    download(dataUrl, 'my-node.png');
+  });
+```
+
+Get a PNG image blob and download it (using [FileSaver](https://github.com/eligrey/FileSaver.js)):
+
+```js
+htmlToImage.toBlob(document.getElementById('my-node'))
+  .then(function (blob) {
+    window.saveAs(blob, 'my-node.png');
+  });
+```
+
+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();
+  });
+```
+
+Get an SVG data URL, but filter out all the `<i>` elements:
+
+```js
+function filter (node) {
+  return (node.tagName !== 'i');
+}
+
+htmlToImage.toSvgDataURL(document.getElementById('my-node'), {filter: filter})
+  .then(function (dataUrl) {
+    /* do something */
+  });
+```
+
+Get 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:
+
+```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);
+      }
+    }
+  });
+```
+
+Get a HTMLCanvasElement, and display it right away:
+
+```js
+htmlToImage.toCanvas(document.getElementById('my-node'))
+  .then(function (canvas) {
+    document.body.appendChild(canvas);
+  });
+```
+
+## Options
+
+### filter
+
+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. 
+
+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.
+
+### style
+
+An 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.
+
+### 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`
+
+### 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.
+
+## Browsers
+
+It's tested on latest Chrome and Firefox (49 and 45 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.*
+
+*Safari is not supported, as it uses a stricter security model on `<foreignObject>` tag. Suggested workaround is to use `toSvg` and render on the server.*
+
+## Dependencies
+
+### Source
+
+Only standard lib is currently used, but make sure your browser supports:
+
+- [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+- SVG `<foreignObject>` tag
+
+### Tests
+
+Most importantly, tests depend on:
+
+- [js-imagediff](https://github.com/HumbleSoftware/js-imagediff), to compare rendered and control images
+
+- [ocrad.js](https://github.com/antimatter15/ocrad.js), for the parts when you can't compare images (due to the browser rendering differences) and just have to test whether the text is rendered
+
+## 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:
+
+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 `<style>` element, then attach it to the clone
+4. Embed images
+   - embed image URLs in `<img>` elements
+   - inline images used in `background` CSS property, in a fashion similar to fonts
+5. Serialize the cloned node to XML
+6. Wrap XML into the `<foreignObject>` tag, then into the SVG, then make it a data URL
+7. 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
+8. 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](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image) - in this case rendering will rather not succeed.
+- Rendering will failed on huge DOM due to the dataURI [limit varies](https://stackoverflow.com/questions/695151/data-protocol-url-size-limitations/41755526#41755526).
+
+## Contributing
+
+Pull requests and stars are highly welcome.
+
+For bugs and feature requests, please [create an issue](https://github.com/bubkoo/html-to-image/issues/new).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52542

increased by2893.85%

Number of package files

23

increased by666.67%

Lines of code

1250

increased byInfinity%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

211

increased by5175%

Worsened metrics

Dev dependency count

22

increased byInfinity%

No dependency changes