React Image Zoom Component

react-image-zoom-component is a React component that provides an image zoom effect when the user hovers over the image. This is ideal for applications like e-commerce platforms where users need to see a detailed view of product images.

Table of Contents

• Installation
• Usage
• Props
• Example
• Customization
• Contributing
• License

Installation

You can install this package using npm:

npm install react-image-zoom-component

or With

yarn add react-image-zoom-component

Usage

To use the ImageZoomComponent, import it into your React component and pass the necessary props:

import React from 'react';
import { ImageZoomComponent } from 'react-image-zoom-component';
import './App.css'; // Optional: Add your own styles

function App() {
  return (
    <div className="App">
      <h1>Image Zoom Component Example</h1>
      <ImageZoomComponent 
        imageUrl="https://example.com/image.jpg"
        zoomImageFromTop="50px"
        zoomImageFromLeft="100px"
        zoomImageWidth="300px"
        zoomImageHeight="300px"
        zoomImageFromBottom="30px"
        zoomImageFromRight="0px"
        ZoomPercentage="200%"
        zommImageBorder="2px solid #fff"
        mainImageClass="main-image-class"
        zommImageBorderRedius="10px"
      />
    </div>
  );
}

export default App;

Props

The component accepts the following props to customize the zoom effect:

| Parameter | Type | Description | Example Value | |--------------------------|----------|----------------------------------------------------------|------------------------| | imageUrl | string | The URL of the image you want to display and zoom in on. | https://example.com/image.jpg | | mainImageClass | string | The CSS class for the main image. | main-image | | zoomImageWidth | string | The width of the zoomed image. | 300px | | zoomImageHeight | string | The height of the zoomed image. | 300px | | zoomImageFromTop | string | The distance from the top for the zoomed image. | 50px | | zoomImageFromLeft | string | The distance from the left for the zoomed image. | 100px | | zoomImageFromRight | string | The distance from the right for the zoomed image. | 0px | | zoomImageFromBottom | string | The distance from the bottom for the zoomed image. | 30px | | ZoomPercentage | string | The zoom level as a percentage. | 200% | | zommImageBorder | string | The border style for the zoomed image. | 2px solid #fff | | zommImageBorderRedius| string | The border-radius for the zoomed image. | 10px |

Example

Here is an example of how to integrate this component into your project:

import React from 'react';
import { ImageZoomComponent } from 'react-image-zoom-component';
import './App.css';

function App() {
  return (
    <div className="App">
      <h1>Product Image Viewer</h1>
      <ImageZoomComponent 
        imageUrl="https://example.com/product.jpg"
        zoomImageFromTop="50px"
        zoomImageFromLeft="50px"
        zoomImageWidth="400px"
        zoomImageHeight="400px"
        zoomImageFromBottom="10px"
        zoomImageFromRight="10px"
        ZoomPercentage="250%"
        zommImageBorder="1px solid #ccc"
        mainImageClass="product-image"
        zommImageBorderRedius="5px"
      />
    </div>
  );
}

export default App;

CSS Example

.product-image {
  width: 200px;
  height: auto;
}

Customization

Feel free to customize the component by applying your own CSS classes or adjusting the component's props to fit your design needs.

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

License

#MIT License

MIT License

Copyright (c) 2024 [Your Name or Your Organization]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.