!Logo-ImageZooom 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 classes via the theme 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.7.0

- Improved accessibility: figure now uses role="button" and tabIndex=0 for keyboard navigation.
- Added theme prop for custom root and image class styling.
- Enhanced error handling: custom errorContent can be rendered on image load failure.
- Refactored internal hooks for better testability and maintainability.
- Updated documentation and examples.

View changelog for previous release notes.

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

Note: CSS is injected automatically with the build. You do not need to import any CSS files manually.

TypeScript: Type definitions are included automatically. No need to install @types/react-image-zooom.

How to Use

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

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

function myZoomableImg() {
return (


`

This component accepts the following attributes:

| Prop | Default value | required |
| --------- | :--------------------------: | -------: |
| className (deprecated) | Null | false |
| theme | undefined | false |
| id | Null | false |
| src | Null | true |
| zoom | 200 | false |
| fullWidth | 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 tag, now let's look at a more advanced example of a gallery using the component (View on CodePen).

`(javascript)
import React from "react"
import ImageZoom from "react-image-zooom";

function myZoomableImg() {
return (


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.