npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wdio-screenshot

v0.6.0

Published

Screenshot commands for WebdriverIO

Downloads

4,490

Readme

wdio-screenshot

A WebdriverIO plugin. Additional commands for taking screenshots with WebdriverIO.

Build Status Build Status Windows npm package

Browser Support

Build Status

  • Firefox
  • Chrome
  • Internet Explorer
  • Safari
  • iOS1 2

Installation

Install wdio-screenshot via NPM as usual:

$ npm install wdio-screenshot --save-dev

Instructions on how to install WebdriverIO can be found here.

Note: If you want to improve performance, you can install GraphicsMagick.

Configuration

Setup wdio-screenshot by adding a wdio-screenshot key to the plugins section of your WebdriverIO config.

// wdio.conf.js
exports.config = {
  // ...
  plugins: {
    'wdio-screenshot': {}
  },
  // ...
};

Usage

wdio-screenshot enhances an WebdriverIO instance with the following commands:

  • browser.saveViewportScreenshot([fileName], [{options}]);
  • browser.saveDocumentScreenshot([fileName], [{options}]);
  • browser.saveElementScreenshot([fileName], elementSelector, [{options}]);

All of these provide options that will help you to exclude unrelevant parts (e.g. content). The following options are available:

  • exclude String[]|Object[] (not yet implemented) exclude frequently changing parts of your screenshot, you can either pass all kinds of different WebdriverIO selector strategies that queries one or multiple elements or you can define x and y values which stretch a rectangle or polygon

  • hide String[] hides all elements queried by all kinds of different WebdriverIO selector strategies (via opacity: 0)

  • remove String[] removes all elements queried by all kinds of different WebdriverIO selector strategies (via display: none)

Use GraphicsMagick

wdio-screenshot uses GraphicsMagick for image processing when available. Without GraphicsMagick installed, wdio-screenshot fallbacks to Jimp - a image processing library written in JS.

If you want to install GraphicsMagick, follow the instructions below.

Mac OS X using Homebrew

$ brew install graphicsmagick

Ubuntu using apt-get

$ sudo apt-get install graphicsmagick

Windows

Download and install executables for GraphicsMagick. Please make sure you install the right binaries desired for your system (32bit vs 64bit).

License

MIT


1 Scaling of iOS Simulator has to be 100% for properly recorded screenshots (see here)

2 iOS scales the zoom level to fit the website into the viewport when the width of your page is bigger than the viewport. Capturing screenshots of such scaled websites with iOS is experimental and error-prone. If you notice any errors, adjust your viewport settings in your meta tag to disable scaling with <meta name="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">