Giter Club home page Giter Club logo

electron-screenshot-service's Introduction

electron-screenshot-service Build Status

Take screenshots using electron

Install

npm install electron-screenshot-service

Usage

var fs = require('fs');
var screenshot = require('electron-screenshot-service');

screenshot({
  url : 'http://google.de',
  width : 1024,
  height : 768
})
.then(function(img){
  fs.writeFile('./out.png', img.data, function(err){
    screenshot.close();
  });
});

screenshot(options)

Will return a Promise containing an object like:

{
  data: <Buffer >
  size: {
    width: X
    height: N
  }
}

In addition to all options that can be passed to the BrowserWindow you can pass:

delay

Type: number (milliseconds)
Default: 0

Delay capturing the screenshot.

Useful when the site does things after loading that you want to capture.

width

Type: number Default: 0

Specify the with of the browser window

height

Type: number Default: 0

Specify the height of the browser window

crop

Type: Object
Default: undefined

An crop object may look like this:

{
  x : 10,
  y : 10,
  width : 100,
  height : 100
}
css

Type: String
Default: undefined

This css will be injected into the page before the screenshot is taken.

js

Type: String
Default: undefined

It must contain a function definition that takes on parameter e.g.

js: 'function(takeScreenshot){ /*Do some stuff*/ takeScreenshot();}'

or

js: 'takeScreenshot => { /*Do some stuff*/ takeScreenshot();}'
transparent

Type: Boolean
Default: false

This will enable transparency. Keep in mind that most site do set a background color on the html/body tag. You can overwrite this by using the css option using something like html,body{ background-color: transparent !important;}.

page

Type: Boolean
Default: false

This will try to capture the whole page. width and height are considered the minimum size.

screenshot.close()

Will close the screenshot service. Needed to let the node process exit

screenshot.scale(scale)

Scale the number of electron processes to scale processes. This will round-robin the screenshot jobs across scale instances.

Changelog

4.0.3
4.0.2
4.0.1
4.0.0
3.3.1
3.3.0
3.2.3
  • Fix PORT bug on windows (Thanks to peerbolte)
3.2.2
3.2.1
  • Fix post install script on windows
3.2.0
3.1.3
3.1.2
3.1.1
  • Fix bug that prevent running in node ^6.0.0
3.1.0
  • Update to [email protected]
  • Use cross-spawn insated of cross-spawn-async
  • Update dependencies
3.0.0
2.3.1
2.3.0
2.2.1
2.2.1
  • Fix installation on windows (#14)
2.2.0
2.1.0
2.0.0
  • Upgrade to [email protected].
  • Fix race-condition in error reporting.
  • Add screenshot.scale API
1.7.0
1.6.0
1.5.3
1.5.3
  • Fix a typo in error handeling code. (Thanks to @adig #6)
  • Pin electron to version 0.33.4
1.5.2
1.5.1
1.5.0
1.4.1
1.4.0
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.4
1.1.3
1.1.1
  • Fixed some issues with error handeling
  • Stop electron from closing when last window was closed
1.1.0
1.0.2
1.0.1
  • Hide the window again.
1.0.0
0.5.0
0.4.5
  • Fix bug on linux (X11)
0.4.4
  • Update to atom-shell .0.22.7
  • Improved perfomance by switching to axon for ipc.
0.4.3
  • Fix scroll jumping
0.4.1
  • Cleanup repository
  • Remove duplicated dependency to socket.io-client
0.4.0
  • Update to atom-shell 0.20.6.
  • Better handeling of pages with iframes
  • Include jquery because of a "bug" in atom-shell (See [#254](See electron/electron#254))
  • Better error handeling
0.3.2
  • Use window.requestAnimationFrame to be sure that at least one paint has happend.
0.3.1
  • Force a redraw after injecting css
0.3.0
  • Add css option to inject custom css
0.2.0
  • Update to atom-shell 0.20.5
  • Add close() method
0.1.3
  • Update to atom-shell 0.19.5
0.1.2
  • Update to atom-shell 0.15.8
0.1.1
  • Update to atom-shell 0.15.4
0.1.0
  • 0.1.0 Inital release

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.