Home

Awesome

<p align="center"> <a href="https://cypress.visual-image-diff.dev/"><img src="./cypress-image-diff-logo.png" width="150" /></a> </p> <h1 align="center">cypress-image-diff</h1>

Visual regression test with cypress

This tool was created to make visual regression as simple as possible, by exposing basic functions that allow you to view the difference between images. The wrapper uses pixelmatch which is simple and powerful and relies on cypress to take screenshots.

NPM Downloads Version Build Status BrowserStack Supporter GitBook Supporter

Writing a test is as simple as this:

describe('Visuals', () => {
  it('should compare screenshot of the entire page', () => {
    cy.visit('www.google.com')
    cy.compareSnapshot('home-page')
  })
})

Beautiful HTML Report

Update baseline screenshots with one click

<img src="https://raw.githubusercontent.com/kien-ht/cypress-image-diff-html-report/main/assets/showcase-update-baseline.gif" alt="showcase-update-baseline"/>

Support different screenshot inspectors

<img src="https://raw.githubusercontent.com/kien-ht/cypress-image-diff-html-report/main/assets/showcase-screenshot-inspectors.gif" alt="showcase-screenshot-inspectors"/>

Cypress Image Diff documentation

Above you will find comprehensive documentation on how to setup this plugin within a cypress test suite