Cypress Image Diff Documentation
  • Migrate from v1 to v2
  • Getting started
    • Cypress integration
      • Typescript
      • Javascript
      • Browserstack
      • Cypress < v10
    • cy.compareSnapshot command
    • Custom config file
      • ROOT_DIR
      • FAILURE_THRESHOLD
      • RETRY_OPTIONS
      • FAIL_ON_MISSING_BASELINE
      • COMPARISON_OPTIONS
      • JSON_REPORT
      • CYPRESS_SCREENSHOT_OPTIONS
      • REPORT_DIR
      • SCREENSHOTS_DIR
      • NAME_TEMPLATE
    • Reporting
      • JSON report
      • Cypress Image Diff HTML Report
      • Legacy HTML Report
    • Client options
    • Running tests
    • Contributing
    • Publishing
Powered by GitBook
On this page
  • Cypress plugin
  • Cypress support
  1. Getting started
  2. Cypress integration

Cypress < v10

Cypress plugin

Import and initialise the Cypress image diff plugin:

// cypress/plugin/index.js
module.exports = (on, config) => {
  const getCompareSnapshotsPlugin = require('cypress-image-diff-js/plugin')
  return getCompareSnapshotsPlugin(on, config)
};

Cypress support

Import and add Cypress image command:

// cypress/support/index.js
require('./commands');

// cypress/support/commands.js
compareSnapshotCommand();
PreviousBrowserstackNextcy.compareSnapshot command

Last updated 1 year ago