react-diff-image
v1.2.0
Published
Zero-dependency component for multi-modal image comparison and review.
Downloads
377
Maintainers
Readme
react-image-diff
Zero-dependency React component providing different modes for diffing or comparing images. The image format is the same as that generated by jest-image-snapshot
, a three part image with the order old-diff-new. All styles are inline for maximum portability.
Four image comparison modes
split
Drag a handle to view a split of old vs new
blend
Using a native input
slider, fade the new image over the old
pixel-diff
Show the diff image directly
side-by-size
Display both image side-by-size
Configuration
showOverlay
Generate a magenta overlay to highlight small changes.
showFullSize
By default the component will responsively fit the image into the container size. Set showFullSize
to true
to display the image at its full size.
showDivider
Defaults to true. Shows an orange divider line between the old and new images in split
mode. Set to false
to hide.
hasPadding
Defaults to false. Adds padding around the images with a standard checkerboard pattern. Makes it easier to see the edges of the images.
Building
npm run build
Demo
Since ImageDiff
does not include any configuration controls, the demo is a simple showcase of the modes and options.
npm run demo:watch
# another terminal
npm run demo:serve
# open http://localhost:3000