mirror/html2canvas
1
0
Fork 0
mirror of https://github.com/niklasvh/html2canvas.git synced 2023-08-10 21:13:10 +03:00
Code Issues Projects Releases Wiki Activity

docs: readability and style updates in README.md

Browse Source
This commit is contained in:
Michael Currin 2021-12-10 11:32:48 +02:00 committed by GitHub
parent 101c32ed71
commit 6c1f0f7733
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -10,10 +10,11 @@ html2canvas
#### JavaScript HTML renderer #### #### 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. The script allows you to take "screenshots" of webpages or parts of it, directly on the user's 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? ### ### 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. 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 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.
@ -40,13 +41,18 @@ support [older browsers](http://caniuse.com/#search=promise) that do not nativel
[es6-promise](https://github.com/jakearchibald/es6-promise) before including `html2canvas`. [es6-promise](https://github.com/jakearchibald/es6-promise) before including `html2canvas`.
To render an `element` with html2canvas, simply call: To render an `element` with html2canvas, simply call:
` html2canvas(element[, options]);`
```javascript
html2canvas(element[, options]);
```
The function returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) containing the `<canvas>` element. Simply add a promise fulfillment handler to the promise using `then`: The function returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) containing the `<canvas>` element. Simply add a promise fulfillment handler to the promise using `then`:
html2canvas(document.body).then(function(canvas) { ```javascript
document.body.appendChild(canvas); html2canvas(document.body).then(function(canvas) {
}); document.body.appendChild(canvas);
});
```
### Building ### ### Building ###
@ -60,7 +66,7 @@ Install dependencies:
$ npm install $ npm install
Build browser bundle Build browser bundle:
$ npm run build $ npm run build