Skip to content
BranchesTags

Repository files navigation

@percy/playwright

Version Test

Percy visual testing for Playwright.

Installation

$ npm install --save-dev @percy/cli @percy/playwright

Usage

This is an example using the percySnapshot function. For other examples of playwright usage, see the Playwright docs.

const { chromium } = require('playwright');
const percySnapshot = require('@percy/playwright');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto('http://example.com/', { waitUntil: 'networkidle2' });
  await percySnapshot(page, 'Example Site');

  await browser.close();
})();

Running the code above directly will result in the following logs:

$ node script.js
[percy] Percy is not running, disabling snapshots

When running with percy exec, and your project's PERCY_TOKEN, a new Percy build will be created and snapshots will be uploaded to your project.

$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- node script.js
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Running "node script.js"
[percy] Snapshot taken "Example Site"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!

Configuration

percySnapshot(page, name[, options])

toHaveScreenshot drop-in

Route your existing Playwright expect(...).toHaveScreenshot() assertions through Percy with one config line and no test changes:

// playwright.config.js
require('@percy/playwright/dropin'); // registers the toHaveScreenshot override

module.exports = defineConfig({ /* your config */ });
PERCY_TOKEN=<web-project-token> npx percy exec -- npx playwright test

Just the standard percy exec — no wrapper, no extra flags. Capture dispatches automatically by your project token:

Project Flow
Web Every toHaveScreenshot() becomes a Percy web snapshot: the live page is serialized with the same capture percySnapshot() uses (readiness gate, responsive capture, cross-origin iframes) and Percy renders it server-side. Locator subjects become element-scoped snapshots.
App The captured PNG uploads straight through the comparison ingest — no render flow, exactly how App Percy ingests screenshots.
anything else A clear wrong-token configuration error (use percyScreenshot() for Automate).

The assertion always passes locally — the visual verdict moves to Percy's review UI, and a missing/invalid token or any Percy error never fails your suite (the whole run falls back to native toHaveScreenshot).

Your committed baselines become the first build — automatically

On a new (empty) Percy project, percy exec detects this package plus the Playwright baseline PNGs already committed in your repo (*-snapshots directories) and establishes the baseline before your tests run:

  1. Build #1 — your committed screenshots are uploaded directly (the suite does NOT run for this) and the build is auto-approved server-side: these are the baselines you've already blessed.
  2. Build #2 — your actual command runs and diffs against that baseline immediately.

With no committed screenshots, the first run itself becomes the auto-approved baseline (matching native Playwright's "first run writes the baselines" behavior). The Percy API decides first-ness from the project token — the flag can never re-baseline an established project.

Existing projects: percy playwright:setup-baseline

On a project that already has builds, percy exec never re-baselines — it prints a notice and carries on. To deliberately (re-)establish the baseline from your committed screenshots (no tests run, auto-approved):

PERCY_TOKEN=<web-project-token> npx percy playwright:setup-baseline

An optional CI gate is available via reporter: [['@percy/playwright/dropin/reporter']] with { "gate": "fail-on-changes" }.

Disabling the drop-in

To keep toHaveScreenshot() fully native (local pixel compare, including the missing-baseline behavior) while still using percySnapshot()/percyScreenshot() under percy exec, either set { "enabled": false } in .percy-playwright-dropin.json or export PERCY_DROPIN_DISABLE=true (the env var also turns off percy exec's baseline seeding). The override steps aside entirely — no snapshots are posted for toHaveScreenshot() assertions.

Requires @playwright/test >= 1.49 (the override hooks Playwright's expect internals; on unsupported versions it degrades to a no-op with a loud warning — never silently).

Percy on Automate

Usage

const { chromium } = require('playwright');
const percyScreenshot = require('@percy/playwright');

const desired_cap = {
  'browser': 'chrome',
  'browser_version': 'latest',
  'os': 'osx',
  'os_version': 'ventura',
  'name': 'Percy Playwright PoA Demo',
  'build': 'percy-playwright-javascript-tutorial',
  'browserstack.username': 'username',
  'browserstack.accessKey': 'accesskey'
};

(async () => {
  const cdpUrl = `wss://cdp.browserstack.com/playwright?caps=${encodeURIComponent(JSON.stringify(desired_cap))}`;
  const browser = await chromium.connect(cdpUrl);
  const page = await browser.newPage();
  await page.goto("https://percy.io/");
  await percyScreenshot(page, 'Screenshot 1');

  // Options for percyScreenshot
  // await percyScreenshot(page, 'Screenshot 1', {
  //   fullPage: true,
  //   percyCSS: 'body { background: red; }',
  //   ignoreRegionSelectors: ['#ignore-this'],
  //   customIgnoreRegions: [{ top: 10, right: 10, bottom: 120, left: 10 }],
  // });

  await browser.close();
})();

Configuration

percyScreenshot(page, name[, options])

  • page (required) - A playwright page instance
  • name (required) - The snapshot name; must be unique to each snapshot
  • options (optional) - There are various options supported by percyScreenshot to server further functionality.
    • sync - Boolean value by default it falls back to false, Gives the processed result around screenshot [From CLI v1.28.8+]
    • fullPage - Boolean value by default it falls back to false, Takes full page screenshot [From CLI v1.27.6+]
    • freezeAnimatedImage - Boolean value by default it falls back to false, you can pass true and percy will freeze image based animations.
    • freezeImageBySelectors - List of selectors. Images will be freezed which are passed using selectors. For this to work freezeAnimatedImage must be set to true.
    • freezeImageByXpaths - List of xpaths. Images will be freezed which are passed using xpaths. For this to work freezeAnimatedImage must be set to true.
    • percyCSS - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
    • ignoreRegionXpaths - List of xpaths. elements in the DOM can be ignored using xpath
    • ignoreRegionSelectors - List of selectors. elements in the DOM can be ignored using selectors.
    • customIgnoreRegions - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.
      • example: {top: 10, right: 10, bottom: 120, left: 10}
      • In above example it will draw rectangle of ignore region as per given coordinates.
        • top (int): Top coordinate of the ignore region.
        • bottom (int): Bottom coordinate of the ignore region.
        • left (int): Left coordinate of the ignore region.
        • right (int): Right coordinate of the ignore region.
    • considerRegionXpaths - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.
    • considerRegionSelectors - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.
    • customConsiderRegions - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries
      • example: {top: 10, right: 10, bottom: 120, left: 10}
      • In above example it will draw rectangle of consider region will be drawn.
      • Parameters:
        • top (int): Top coordinate of the consider region.
        • bottom (int): Bottom coordinate of the consider region.
        • left (int): Left coordinate of the consider region.
        • right (int): Right coordinate of the consider region.
    • regions parameter that allows users to apply snapshot options to specific areas of the page. This parameter is an array where each object defines a custom region with configurations.
      • Parameters:

        • elementSelector (optional, only one of the following must be provided, if this is not provided then full page will be considered as region)

          • boundingBox (object): Defines the coordinates and size of the region.
            • x (number): X-coordinate of the region.
            • y (number): Y-coordinate of the region.
            • width (number): Width of the region.
            • height (number): Height of the region.
          • elementXpath (string): The XPath selector for the element.
          • elementCSS (string): The CSS selector for the element.

        • algorithm (mandatory)

          • Specifies the snapshot comparison algorithm.
          • Allowed values: standard, layout, ignore, intelliignore.

        • configuration (required for standard and intelliignore algorithms, ignored otherwise)

          • diffSensitivity (number): Sensitivity level for detecting differences.
          • imageIgnoreThreshold (number): Threshold for ignoring minor image differences.
          • carouselsEnabled (boolean): Whether to enable carousel detection.
          • bannersEnabled (boolean): Whether to enable banner detection.
          • adsEnabled (boolean): Whether to enable ad detection.

        • assertion (optional)

          • Defines assertions to apply to the region.
          • diffIgnoreThreshold (number): The threshold for ignoring minor differences.

Example Usage for regions

const obj1 = {
  elementSelector: {
    elementCSS: ".ad-banner" 
  },
  algorithm: "intelliignore", 
  configuration: {
    diffSensitivity: 2,
    imageIgnoreThreshold: 0.2,
    carouselsEnabled: true,
    bannersEnabled: true,
    adsEnabled: true
  },
  assertion: {
    diffIgnoreThreshold: 0.4,
  }
};

// we can use the createRegion function

const { createRegion } = percySnapshot;

const obj2 = createRegion({
  algorithm: "intelliignore",
  diffSensitivity: 3,
  adsEnabled: true,
  diffIgnoreThreshold: 0.4
});

percySnapshot(page, "Homepage 1", { regions: [obj1] });

Creating Percy on automate build

Note: Automate Percy Token starts with auto keyword. The command can be triggered using exec keyword.

$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [playwright test command]
[percy] Percy has started!
[percy] [Playwright example] : Starting automate screenshot ...
[percy] Screenshot taken "Playwright example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!

Refer to docs here: Percy on Automate

About

Playwright client library for visual testing with Percy

Topics

percypercy-sdkplaywrighttestingvisual-testing

Resources

Readme
MIT license
Activity
Custom properties

Stars

17 stars

Watchers

7 watching

Forks

6 forks
Report repository

Releases

Used by

Contributors

Languages