html2canvas

Homepage | Downloads | Questions

JavaScript HTML renderer

The script allows you to take "screenshots" of webpages or parts of it, directly on the users browser. The screenshot is based on the DOM and as such may not be 100% accurate to the real representation as it does not make an actual screenshot, but builds the screenshot based on the information available on the page.

Why another html2canvas package?

This is a fork of niklasvh/html2canvas & nidi3/html2canvas that includes various fixes and new features. It offers several advantages over the original html2canvas, such as:

• Gracefully handles cross-origin images
• Gracefully handles color and advanced CSS properties
• Supports SVG rendering
• Support for object-fit and object-position CSS properties thanks to @yorickshan

Installation

npm install @codewonders/html2canvas

Example ScreenShot

• With @codewonders/html2canvas Handle textarea rendering, Cross-origin images, colors, SVG rendering, object-fit and object-position CSS properties

• With niklasvh/html2canvas

• With html2canvas-pro Handles colors but breaks screenshot, textarea rendering is off by a few pixels

Browser compatibility

The library should work fine on the following browsers (with Promise polyfill):

• Firefox 3.5+
• Google Chrome
• Opera 12+
• IE9+
• Safari 6+

As each CSS property needs to be manually built to be supported, there are a number of properties that are not yet supported.

Usage

The html2canvas library utilizes Promises and expects them to be available in the global context. If you wish to support older browsers that do not natively support Promises, please include a polyfill such as es6-promise before including html2canvas.

To render an element with html2canvas, simply call: html2canvas(element[, options]);

The function returns a Promise containing the <canvas> element. Simply add a promise fulfillment handler to the promise using then:

html2canvas(document.body).then(function(canvas) {
    document.body.appendChild(canvas);
});

Building

You can download ready builds here.

Clone git repository:

$ git clone git://github.com/niklasvh/html2canvas.git

Install dependencies:

$ npm install

Build browser bundle

$ npm run build

Examples

For more information and examples, please visit the homepage or try the test console.

Contributing

If you wish to contribute to the project, please send the pull requests to the develop branch. Before submitting any changes, try and test that the changes work with all the support browsers. If some CSS property isn't supported or is incomplete, please create appropriate tests for it as well before submitting any code changes.