Webpage-capture NPM

webpage-capture

A super simple way to capture webpages screenshots using phantomjs.

Installation

If you want to use it inside your scripts, save and install it in your project dependencies.

npm install --save webpage-capture
yarn add webpage-capture

Once it has done you can require webpage-capture in your script and start using it.

Global module

You can also use it as a cli-tool installing it as a global module:

npm install -g webpage-capture
yarn global add webpage-capture

Than you can start playing around with the options using the built-in help typing: -h, --help

Usage

The most basic use is with a single input and default settings:

const webCapture = require('webpage-capture');
webCapture('https://github.com/b4dnewz', {}, (err, res) => {
  // handle err
  console.log('Output saved to:', res);
});

You can also capture multiple source urls:

const webCapture = require('webpage-capture');
webCapture([
  'https://github.com/b4dnewz',
  'https://github.com/b4dnewz/webpage-capture'
], {}, (err, res) => {
  // handle err
  console.log('Output saved to:', res);
});

Or render HTML text and capture it:

const webCapture = require('webpage-capture');
webCapture('<h1>this is c00l</h1>', {}, (err, res) => {
  // handle err
  console.log('Output saved to:', res);
});

It can also render the same source in multiple viewports resolutions:

const webCapture = require('webpage-capture');
webCapture('https://github.com/b4dnewz', {
  viewport: ['desktop', 'laptop-mdpi', 'nexus-7']
}, (err, res) => {
  // handle err
  console.log('Output saved to:', res);
});

It can accept many options to customize the capturing behavior:

const webCapture = require('webpage-capture');
const options = {
  debug: false,
  outputDir: './output',
  outputType: 'file',
  whiteBackground: true,
  renderOptions: {
    format: 'png',
    quality: 80
  },
  crop: false,
  clipRect: {
    top: 0,
    left: 0
  },
  viewport: 'desktop',
  userAgent: 'random'
};

webCapture('https://github.com/b4dnewz', options, (err, res) => {
  // handle err
  console.log('Output saved to:', res);
});