html2canvas README

The project's README from github.com/niklasvh/html2canvas. As one markdown file: README.md.

html2canvas

Homepage | Downloads | Questions

Gitter CI NPM Downloads NPM Version

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):

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.

html2canvas (niklasvh/html2canvas)

Searching Database…

Что это такое?html2canvas — это JavaScript-библиотека, которая делает «скриншоты» веб-страниц или их отдельных частей прямо в браузере пользователя, без необходимости в сервере.
Это настоящий скриншот или что-то другое?Нет, это не настоящий снимок экрана. Библиотека читает DOM и CSS-стили, применённые к элементам, и заново собирает страницу в виде изображения canvas, поэтому визуально результат может быть не на все 100% точным.
Как её использовать в моём проекте?Подключите html2canvas и вызовите html2canvas(element, options). Функция возвращает Promise, который разрешается в canvas. Его можно добавить на страницу, например: html2canvas(document.body).then(canvas => document.body.appendChild(canvas)).
Нужно ли что-то ещё, например полифилл для Promise?Библиотека рассчитывает, что Promise доступен глобально. Для старых браузеров без нативной поддержки Promise нужно подключить полифилл, например es6-promise, до загрузки html2canvas.
Есть ли подводные камни, например с контентом с другого источника или с поддержкой Node.js?Библиотека сильно зависит от браузера, поэтому не может работать в Node.js. Она также не может обходить политики безопасности браузера, поэтому для отрисовки контента с другого источника (cross-origin) нужен прокси, который отдаёт его с того же источника. Автор также называет библиотеку экспериментальной и пока не рекомендует использовать её в продакшене.
Какие браузеры она поддерживает?Работает в Firefox 3.5+, Chrome, Opera 12+, IE9+ и Safari 6+ (с полифиллом для Promise), так как каждое поддерживаемое CSS-свойство приходится реализовывать вручную.
Почему она не может просто сделать снимок реальных пикселей страницы?Поскольку библиотека работает полностью в браузере, без рендеринга на стороне сервера, ей приходится заново воссоздавать внешний вид страницы, читая DOM и CSS. Поэтому пока поддерживаются не все CSS-свойства.
Полностью ли поддерживается CSS?Нет, каждое CSS-свойство нужно реализовывать вручную, поэтому ряд CSS-свойств пока не обрабатывается.
Creator
niklasvh
Size
114.6 MB
Stars
31.9K
Age
15y
Commits · 90 Days