Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

To send Playwright visual snapshots to Percy, install the Percy CLI and Playwright integration, add either Percy’s drop-in for existing toHaveScreenshot() tests or explicit percySnapshot() calls, set a project-specific PERCY_TOKEN, then run the test command through percy exec. The drop-in route requires no test-file edits; explicit snapshots give you control over exactly where captures happen.

Choose a Percy setup path

Path Use it when Test changes
Drop-in integration Your JavaScript or TypeScript suite already uses Playwright’s toHaveScreenshot() and you want Percy to collect those captures. Add one import to the Playwright configuration; no test-file edits are required.
Explicit SDK snapshots You want to choose the exact pages or points in a test where Percy captures snapshots. Import percySnapshot and call it from test code.
Sample project You want to see a Percy build before connecting your own suite. Start with the official Percy getting-started guide.

Both integration routes use the Percy CLI, a Percy project token, and a test command run under Percy. A BrowserStack-hosted browser or Automate configuration is not required for the basic SDK workflow; it is an optional project configuration described in the JavaScript integration guide.

Prerequisites for the drop-in integration

The Percy Playwright reference lists these minimums for the toHaveScreenshot() drop-in: Node 18 or later, @playwright/test 1.60 or later, @percy/cli 1.32.6 or later, and @percy/playwright 1.1.2 or later. Package and runtime requirements can change; check the current Playwright reference if installation or execution fails.

The instructions below assume a JavaScript or TypeScript project using Playwright Test and npm. Use the package manager and test command your project already uses if they differ.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.

Set up Percy for existing toHaveScreenshot() tests

  1. From the project directory, install the Percy CLI and Playwright integration:

    npm install --save-dev @percy/cli @percy/playwright
  2. Load the drop-in before the Playwright configuration. For a CommonJS configuration file such as playwright.config.js, add:

    require('@percy/playwright/dropin');
    const { defineConfig } = require('@playwright/test');
    
    module.exports = defineConfig({
      // existing configuration
    });

    Keep your existing configuration in place. The import registers Percy’s handling for calls to toHaveScreenshot(); you do not need to edit each test file for this route.

  3. Copy the token for your Percy project and provide it through the environment when running the tests:

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
    PERCY_TOKEN=<your-project-token> npx percy exec -- npx playwright test

    Replace <your-project-token> with the project token. Do not commit the token or put it in source code.

  4. Run the command locally or in CI. Review the resulting Percy build and handle visual changes in Percy rather than treating a passing Playwright run as proof that every page is visually unchanged.

    Rank #2
    Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
    • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
    • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
    • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
    • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
    • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

For an existing suite that already calls toHaveScreenshot(), this is the shortest route from Playwright checks to Percy snapshots. See the official drop-in integration reference for supported setup details.

Take explicit Percy snapshots from a Playwright script

Choose this route when capture points should be visible in test code. Install the same packages, create a Percy project, and set its token as PERCY_TOKEN as described in the JavaScript SDK guide. Then import percySnapshot, navigate with Playwright, and call it on the page you want captured:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
const { chromium } = require('@playwright/test');
const percySnapshot = require('@percy/playwright');

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

Save the script as a project file, for example visual-check.js, then run it through Percy:

PERCY_TOKEN=<your-project-token> npx percy exec -- node visual-check.js

Use a descriptive snapshot name: it is the label reviewers see when inspecting the Percy build. In an existing Playwright Test suite, place the percySnapshot(page, 'Name') call after navigation and after any interactions or loading waits needed to reach the state you want reviewed.

If wrapping the test command is impractical, the JavaScript guide also documents starting Percy with percy exec:start and stopping it with percy exec:stop around the test command. Consult that guide for the exact invocation and lifecycle details.

Run Percy in CI and protect the token

Set PERCY_TOKEN as a protected secret in your CI provider, then run the same percy exec -- <test command> workflow used locally. BrowserStack describes the token as write-only and unique to each Percy project, and says it should be kept secret in its Percy CI/CD documentation.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.
  • Do not print the token in build logs or commit it to the repository.
  • Use the token for the Percy project whose build should receive these snapshots.
  • Run the full test command through Percy so the CLI can collect snapshots during execution.
  • Percy documents support for most parallelized test environments, where snapshots from processes or machines are collected into the same build. Confirm that your CI setup follows the CLI’s supported workflow.

Make build review part of the team’s visual-testing process. A successful test command does not itself approve visual changes or establish that the Percy baseline is correct.

Configure snapshots and baselines only when needed

The basic integrations focus on packages, token, and the wrapped test command. For optional tuning, the Percy CLI can generate a configuration file with percy config:create. The Percy configuration options reference describes settings including snapshot widths, minimum height, Percy CSS, asset discovery, hostnames, and uploads. Add configuration when your project needs those behaviors rather than treating it as a prerequisite.

The Playwright reference also documents a baseline setup command for projects that use committed screenshots, but that path depends on project conditions, including use of the default config file and particular screenshot naming and path settings. Check the documented conditions before using it; it is not a universal shortcut for custom Playwright configurations.

Do a focused first-run check

  1. Confirm the installed Node and package versions meet the integration’s listed minimums.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  2. Check that the drop-in import loads from the Playwright configuration, or that explicit snapshots call percySnapshot with the intended page and a useful name.

  3. Verify the Percy project token is available to the process as PERCY_TOKEN.

    Rank #4
    Sale
    UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
    • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
    • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
    • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
    • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
    • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
  4. Run one representative test through percy exec and inspect the resulting Percy build.

  5. Review snapshots and baselines in Percy; do not infer visual approval from the test process exit status alone.

    What’s actually slowing this PC down?

    Pick the symptom - the matching free tool is one click away.

    Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Troubleshooting common setup problems

No Percy build or snapshots appear

Check that the command is wrapped with npx percy exec --, that the process can read the correct project’s PERCY_TOKEN, and that the drop-in import runs from the Playwright configuration. For explicit snapshots, verify the test actually reaches the percySnapshot() call.

The token is missing or rejected

Set the token in the shell or CI secret configuration as PERCY_TOKEN, without committing it to a file that is tracked. Confirm that it belongs to the intended Percy project and that secret masking or environment scoping has not prevented the test process from receiving it.

toHaveScreenshot() runs but Percy does not collect it

Verify that @percy/playwright/dropin is imported by the active Playwright configuration and that the installed CLI, integration, Playwright Test, and Node versions meet the documented minimums. The drop-in is specifically for Playwright’s screenshot assertion calls.

The Playwright run passes, but a visual difference is present

That outcome is expected: a passing drop-in test run does not replace reviewing the Percy visual build. Inspect the comparison and approve or update the baseline according to your team’s review process.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

Committed-baseline setup does not fit the project

The documented baseline route has configuration and screenshot path/name conditions. If your project uses a custom configuration or different screenshot conventions, use the ordinary Percy integration workflow unless the reference confirms your setup meets those conditions.

Wrapping the test command is not practical

Use the documented percy exec:start and percy exec:stop lifecycle around the test command, following the JavaScript SDK guide. Keep token handling and build review the same as in the wrapped-command workflow.

Or skip the browser setup

If your immediate need is a website screenshot rather than Percy visual regression testing inside Playwright, ScreenshotNeo offers a screenshot API and MCP server. One GET request can return a PNG, JPEG, WebP, or PDF, without installing or running a browser test suite.

For example, using cURL (see the ScreenshotNeo API documentation):

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

ScreenshotNeo removes cookie and consent banners, newsletter popups, and chat widgets before capture; those steps can be turned off. Bot checks or CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed, and the response includes X-Page-Verdict and X-Billed headers. Its MCP server provides take_screenshot, get_page_info, and capture_pdf tools for AI agents. The free plan includes 1,000 screenshots a month with no card; paid plans start at $5 for 3,000 screenshots.

Sign up for ScreenshotNeo free to get 1,000 screenshots a month with no card.

Frequently Asked Questions

Do I need BrowserStack Automate to use Percy with Playwright?

No. The basic Percy SDK workflow can run with your Playwright tests; hosted browser execution is an optional configuration.

Can I use Percy with TypeScript tests?

The drop-in route is documented for JavaScript or TypeScript Playwright suites; load the drop-in from the configuration used by your test runner.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.