grunt-pageres

Capture website screenshots

grunt-pageres

Capture website screenshots using pageres

Issues should be opened on the pageres issue tracker.

Using another task runner?

$ npm install --save-dev grunt-pageres

PhantomJS, which is used for generating the screenshots, is installed automagically, but in some rare cases it might fail to and you'll get an Error: spawn EACCES error. Download PhantomJS manually and reinstall this task if that happens.

require('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks 
 
grunt.initConfig({
    pageres: {
        screenshot: {
            options: {
                urls: 'yeoman.io',
                sizes: ['1200x800', '800x600'],
                dest: 'dist'
            }
        },
        multipleUrls: {
            options: {
                urls: ['todomvc.com', 'google.com'],
                sizes: ['800x1000', '400x1000'],
                dest: 'dist',
                crop: true
            }
        }
    }
});
 
grunt.registerTask('default', ['pageres']);

Required
Type: string, array

One or more URLs or local paths to the websites you want to screenshot.

Required
Type: array

Use a <width>x<height> notation or a keyword.

A keyword is a version of a device from this list. You can also pass in the w3counter keyword to use the ten most popular resolutions from w3counter.

Required
Type: string

Destination directory.

Type: number (seconds)
Default: 0

Delay capturing the screenshot.

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

Type: boolean
Default: false

Crop to the set height.

Type: array of string, object

A string with the same format as a browser cookie or an object of what phantomjs.addCookie accepts.

Go to the website you want a cookie for and copy-paste it from Dev Tools.

Type: string

Define a customized filename using Lo-Dash templates.
For example {{date}} - {{url}}-{{size}}{{crop}}.

Available variables:

  • url: The URL in slugified form, eg. http://yeoman.io/blog/ becomes yeoman.io!blog
  • size: Specified size, eg. 1024x1000
  • width: Width of the specified size, eg. 1024
  • height: Height of the specified size, eg. 1000
  • crop: Outputs -cropped when the crop option is true
  • date: The current date (Y-M-d), eg. 2015-05-18
  • time: The current time (h-m-s), eg. 21-15-11

Type: string

Capture a specific DOM element.

Type: array

Hide an array of DOM elements.

Type: string

Username for authenticating with HTTP auth.

Type: string

Password for authenticating with HTTP auth.

Type: number

Scale webpage n of times.

Type: String
Default: png
Values: png, jpg

Image format.

Type: string

Custom user agent.

MIT © Sindre Sorhus