react-image-zooom

Image-Zooom a React Component

Simple React component that will allow users to zoom in on your images, perfect for product images and galleries!

Small and light weight!

View it in action on this demo page!
Alternatively on this Pen @CodePen

Buy me a coffee to keep me going!

Why?

As a long user of jQuery I have developed many plugins over the years that have helped me developing solutions faster and more reliably. As I move and transition to React(♥) I wanted some of these to come along with me on this new journey.

I like my plugins(now components) to be as flexible as possible and to not get in the way of the styling of the app/site that is been implemented to and this is no different.

Want to come along on this journey and/or have some great ideas on how to improve this component? Check out the repo here!

How it works?

This component has a very minimal styling footprint only setting the minimum to make it work, in addition you can pass in your own className and id props enabling you to adapt the design to your needs.

For extra customization of the style of this component it will also add some extra classes dynamically depending on its state.

It will have the class loading while the image is been preloaded and loaded once it has been loaded.

Additionally it will have the class fullview while the user has not initiated the zoom and zoomed once the user has taped/clicked in.

New to v1.4.0

Performance updates and allowing to set the zoom level to the image with rather than percentage, this will calculate the correct percentage to display the image in its true size and default to the percentage if this value would be less than 100%.

Example:

import React from "react"
import ImageZoom from "react-image-zooom";

function myZoomableImg() {
  return (
    <div>
      <ImageZoom 
        src="https://picsum.photos/seed/022/3840/2160" 
        alt="A image to apply the ImageZoom plugin" 
        fullWidth={true} 
      /> 
      // fullWidth -> this will automatically calculate the correct zoom percentage
      // to display the image at the original width if this is above 100% or default to the zoom level provided
    </div>
  );
}

export default myZoomableImg;

New to v1.3.0

As requested by the users, this is now supported by mobile devices.

New to v1.2.0

As requested by the users, you can now have custom components rendered when the image fails to load and pass in a custom callback to handle the error your own way.

How to install

To install this on your project run the following command on your terminal:
npm install react-image-zooom

Alternatively you can also install using yarn:
yarn add react-image-zooom

How to Use

Here is a basic example of how to import and use this component (View on CodePen):

import React from "react"
import ImageZoom from "react-image-zooom";

function myZoomableImg() {
  return (
    <div>
      <ImageZoom src="https://picsum.photos/seed/000/1920/1080" alt="A image to apply the ImageZoom plugin" zoom="200"/>
    </div>
  );
}

export default myZoomableImg;

This component accepts the following attributes:

Prop	Default value	required
className	Null	false
id	Null	false
src	Null	true
zoom	200	false
fullWifth	false	false
alt	"This is an imageZoom image"	false
width	"100%"	false
height	"auto"	false

As you can see above, it is very similar to the standard <img /> tag, now let's look at a more advanced example of a gallery using the component (View on CodePen).

import React from "react"
import ImageZoom from "react-image-zooom";

function myZoomableImg() {
  return (
    <ul className="myGallery">
        <li><ImageZoom className="myGalleryImg" src="https://picsum.photos/seed/001/1920/1080" alt="My gallery image 1" zoom="300"/></li>
        <li><ImageZoom className="myGalleryImg" src="https://picsum.photos/seed/002/1920/1080" alt="My gallery image 2" zoom="200"/></li>
        <li><ImageZoom className="myGalleryImg" src="https://picsum.photos/seed/003/1920/1080" alt="My gallery image 3" zoom="200"/></li>
        <li><ImageZoom className="myGalleryImg" src="https://picsum.photos/seed/004/1920/1080" alt="My gallery image 4" zoom="300"/></li>
    </ul>
  );
}

export default myZoomableImg;

Note that you can also set different Zoom levels per image.
For more examples see this demo page!

Bugs and issues

Please report all bugs and issues here.