Gathering detailed insights and metrics for html2canvas
Gathering detailed insights and metrics for html2canvas
Gathering detailed insights and metrics for html2canvas
Gathering detailed insights and metrics for html2canvas
npm install html2canvas
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
30,662 Stars
1,066 Commits
4,819 Forks
506 Watching
6 Branches
50 Contributors
Updated on 28 Nov 2024
Minified
Minified + Gzipped
TypeScript (58.25%)
HTML (29.98%)
JavaScript (11.51%)
CSS (0.26%)
Cumulative downloads
Total Downloads
Last day
-3.2%
440,823
Compared to previous day
Last week
2.9%
2,381,173
Compared to previous week
Last month
11%
9,926,461
Compared to previous month
Last year
37%
93,941,274
Compared to previous year
2
72
Homepage | Downloads | Questions
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.
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.
The library should work fine on the following browsers (with Promise
polyfill):
As each CSS property needs to be manually built to be supported, there are a number of properties that are not yet supported.
The html2canvas library utilizes Promise
s and expects them to be available in the global context. If you wish to
support older browsers that do not natively support Promise
s, 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);
});
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
For more information and examples, please visit the homepage or try the test console.
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.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
Project has not signed or included provenance with any releases.
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
141 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-18
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