html2canvas

What is html2canvas?

The html2canvas npm package is a JavaScript library that allows you to take screenshots of web pages or parts of them directly in the browser. It captures the content of HTML elements as a canvas image.

What are html2canvas's main functionalities?

Screenshot of the entire page or specific elements

This code takes a screenshot of the entire body of the webpage and appends the resulting canvas to the body. You can replace `document.body` with any other element to capture a specific part of the page.

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

Configuration options for the screenshot

This code demonstrates how to pass configuration options to html2canvas. Options such as `onclone`, `width`, and `height` can be used to customize the screenshot process.

html2canvas(element, {
  onclone: function(clonedDoc) {},
  width: 800,
  height: 600
}).then(function(canvas) {
  document.body.appendChild(canvas);
});

Saving the canvas as an image

After capturing the screenshot, this code converts the canvas to a PNG image and triggers a download of the image file.

html2canvas(element).then(function(canvas) {
  var img = canvas.toDataURL('image/png');
  var link = document.createElement('a');
  link.href = img;
  link.download = 'screenshot.png';
  link.click();
});

Other packages similar to html2canvas

dom-to-image

dom-to-image is similar to html2canvas in that it can turn DOM nodes into images. It uses SVG to render the image, which can lead to different results compared to html2canvas's canvas-based approach. It might handle certain styling and elements differently.

puppeteer

puppeteer is a Node library which provides a high-level API to control Chrome or Chromium over the DevTools Protocol. It is capable of taking screenshots and generating PDFs of pages. Unlike html2canvas, puppeteer runs on the server-side and requires a headless browser, offering a different approach to rendering pages.

README

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.

How does it work?

The script renders the current page as a canvas image, by reading the DOM and the different styles applied to the elements.

It does not require any rendering from the server, as the whole image is created on the client's browser. However, as it is heavily dependent on the browser, this library is not suitable to be used in nodejs. It doesn't magically circumvent any browser content policy restrictions either, so rendering cross-origin content will require a proxy to get the content to the same origin.

The script is still in a very experimental state, so I don't recommend using it in a production environment nor start building applications with it yet, as there will be still major changes made.

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.

Changelog

1.4.1 (2022-01-22)

deps

• fix source maps (#2812) (67c5e8d), closes #2812

feat

• add support for <video> elements (#2788) (181d1b1), closes #2788

fix

• Properties x and y of BoundingRect is undefined in old browser (#2797) (e587a82), closes #2797
• source maps (#2787) (46db867), closes #2787