snapage v1.3.2

snapage

snap a page !

snapage allows to create high quality web page screenshots/pdfs, for multiple viewports concurrently, with custom styles, element screeenshots, scripts and more!

install

npm install snapage

usage

const snap = require('snapage');
(async () => {
  await snap('https://apple.com', {
    name: 'iPad Pro',
    fullPage: true,
    scroll: true,
    viewports: ['iPad Pro'],
    style: {
      filter: 'grayscale(100%)'
    }
  });
})();

features

✅ plug and play
✅ element & full page screenshots
✅ custom css styles
✅ custom script to run before snap
✅ supports pdf
✅ supports all chrome emulated devices and their orientation
✅ supports lazy loaded content by scrolling the page
✅ uses puppeteer-cluster for concurrenct screenshots

api

export type Style = Record<string, string>;

// for string viewport, snapage will emulate the given device (e.g 'Nexus 4 landscape')
// see pptr devices: https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts
export type Viewport = string | {
  width?: number;
  height?: number;
}


export type SnapOptions = {
  name?: string;
  path?: string;
  viewports?: Viewport[];
  style?: Style;
  script?: string;
  fullPage?: boolean;
  scroll?: boolean;
  persist?: boolean;
  printBackground?: boolean;
  mode?: string;
  wait?: number;
};

export type SnapMeta = {
  name: string;
  snapPath: string;
  snapDir: string;
  viewport: Viewport;
  device: boolean;
  opts: Record<string, any>;
};

export type SnapResult = {
  meta: SnapMeta[];
  snaps: Buffer[];
}

export default function snap(url: string, options?: SnapOptions): Promise<SnapResult>;

examples

pdf

snap a full page pdf of apple.com, in an iPhone X and desktop 800x600, scroll the page to get lazy loaded content.

const snap = require('snapage');
(async () => {
  await snap('https://apple.com', {
    mode: 'pdf', 
    scroll: true, 
    viewports: ['iPhone X', {width: 800, height: 600}]
  });
})()

custom css style

snap a viewport screenshot of apple.com, on desktop 800x600, desaturate colors by 50%.

const snap = require('snapage');
(async () => {
  await snap('https://apple.com', {
    style: {
      filter: 'saturate(50%)'
    }, 
    viewports: [{width: 800, height: 600}, '']
  });
})()

custom script

snap a viewport screenshot of npmjs.com, on desktop 1200x1080, add a red border to every element on the page via a script.

const snap = require('snapage');
(async () => {
  await snap('https://www.npmjs.com', {
    script: 'document.querySelectorAll("*").forEach(e => e.style.border = "1px solid red")',
    viewports: [{width: 1200, height: 1080}]
  });
})()

don't persist

don't persist screenshots instead return screenshot per viewport provided in the viewports array. by default, snapagesaves the screenshots/pdfs to the snapDir provided in config.

import snap, {SnapResult} from 'snapage';
const screenshots: SnapResult = await snap('https://google.com', {
    persist: false,
    viewports: ['iPad Pro', { width: 800, height: 600 }],
  });
console.log(screenshots);
// {
//   snaps: [
//     <Buffer 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 00 00 08 00 00 00 0a ac 08 06 00 00 00 4b e6 13 8c 00 00 00 01 73 52 47 42 00 ae ce 1c e9 00 00 20 00 ... 204866 more bytes>,
//     <Buffer 89 50 4e 47 0d 0a 1a 0a 00 00 00 0d 49 48 44 52 00 00 0c 80 00 00 09 60 08 06 00 00 00 4a f8 ad 5d 00 00 00 01 73 52 47 42 00 ae ce 1c e9 00 00 20 00 ... 638779 more bytes>
//   ],
//   meta: [
//     {
//       viewport: 'iPad Pro',
//       name: 'snap_YCT5Qt5',
//       snapPath: undefined,
//       snapDir: '/workspaces/experiments/snapage/snaps',
//       opts: [Object],
//       device: true
//     },
//     {
//       viewport: [Object],
//       name: 'snap_aW3dz0g',
//       snapPath: undefined,
//       snapDir: '/workspaces/experiments/snapage/snaps',
//       opts: [Object],
//       device: false
//     },
//   ]
// }