@caffeina.dev/react-imagezoomer
v1.1.0
Published
React component for zoom an image on mouse over
Downloads
3
Readme
🔍 React Imagezoomer 🔎
React Imagezoomer is an zoomer
component for React.js.
With React Imagezoomer you can specify an image and zoom it using your mouse or your finger.
You can find the preview on Storybook
Getting started
- To include the code locally install
@caffeina.dev/react-imagezoomer
using npm:
npm install @caffeina.dev/react-imagezoomer --save
- To include the code globally from a cdn:
<script src="https://unpkg.com/@caffeina.dev/react-imagezoomer/dist/lib/"></script>
Dependencies
react-imagezoomer
has no external dependencies, aside for the usual react
and prop-types
.
Documentation
Include react-imagezoomer
in your component:
// using an ES6 transpiler, like babel
import ImageZoomer from 'react-imagezoomer'
// otherwise
let ImageZoomer = require('react-imagezoomer')
and set a source image to zoom
const myComponent = () => <ImageZoomer image="https://source.unsplash.com/random">
you can also pass your personal classes to change the default style of the package
const conf = {
zommerContainerClass: 'imagezoomer',
zommerClass: 'imagezoomer__inner'
}
const myComponent = () => <ImageZoomer conf={conf} image="https://source.unsplash.com/random">
you can change the default zoom level passing it in the config props
const conf = {
zoom: 12
}
const myComponent = () => <ImageZoomer conf={conf} image="https://source.unsplash.com/random">
Contributing
Reporting bugs
- Open a GitHub issue
Contributing with patches and bug fixes
- Open a new GitHub pull request with the patch.
- Ensure the PR description clearly describes the problem and solution.
Contributors
- Riccardo Canella @thecreazy
- Alberto Parziale @lavolpecheprogramma
License
MIT