npmpackage.info

Gathering detailed insights and metrics for react-image-zoom-hook

Other packages similar to react-image-zoom-hook

react-medium-image-zoom

5.2.11

Accessible medium.com-style image zoom for React

react-svg-pan-zoom

3.13.1

A React component that adds pan and zoom features to SVG

react-inner-image-zoom

3.0.2

A React component for magnifying an image within its original container.

@likashefqet/react-native-image-zoom

4.2.1

A performant zoomable image written in Reanimated v2+ 🚀

Gathering detailed insights and metrics for react-image-zoom-hook

react-image-zoom-hook

A customisable Reactjs hook for image zoom 🌽

0.1.13

MIT

TypeScript

62,914 2.5

Installations

npm install react-image-zoom-hook

Score

59.4

Supply Chain

93.5

Quality

75.3

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

36

Total

57

Closed

20

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

simbathesailor

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=8

Typescript Support

No

Node Version

12.10.0

NPM Version

6.10.3 Statistics

8 Stars

33 Commits

3 Watching

39 Branches

1 Contributors

Updated on 04 Mar 2023

Languages

TypeScript (67.84%)

CSS (21.14%)

JavaScript (9.28%)

HTML (1.75%)

Total Downloads

Cumulative downloads

Total Downloads

62,914

Last day

-50%

Compared to previous day

Last week

6.8%

Compared to previous week

Last month

-14.3%

305

Compared to previous month

Last year

-55.4%

5,142

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Image zoom react hook

Installing

If using npm, Run

1
2npm install --save react-image-zoom-hook
3

If using yarn , Run

1
2yarn add react-image-zoom-hook
3

Getting Started

To understand the usage, Let's look at the jsx used to render the above example shown in gif. The jsx structure will remain more or less same of various implementation.

1<>
2  <div onMouseMove={moveLens} style={{ ...imgContainerDimesions }}>
3    <div ref={meshRefCallback} style={{ ...lensDimensions }} />
4
5    <img
6      style={{
7        ...imgDimesions
8      }}
9      ref={imgRefCallback}
10      alt="test"
11      src={img}
12    />
13  </div>
14
15  <div style={{ ...previewLensDimensions }}>
16    <img
17      ref={imagePreviewRefCallback}
18      alt="test-preview"
19      src={previewImg}
20      style={{
21        ...previewImgDimensions
22      }}
23    />
24  </div>
25</>

Let's see the visual reperesentation of the layout described above in jsx

Pictorial representation

Following are the segregation of properties based on different element

Element	Attributes returned by Hook
Image Container	moveLens, imgContainerDimesions
Lens or Mesh	lensDimensions, meshRefCallback
Image	imgDimesions, imgRefCallback
Preview Image	imagePreviewRefCallback, previewImgDimensions
Preview Lens	previewLensDimensions

Customisation:

It is fully customisable, as implementing component is in consumer's control.
Any custom styling can be applied to all the elements mentioned in above table.

Live Example

Example customized zoom

Default Zoom

1/**
2
3* Example of default view
4
5*/
6import React from "react";
7import useImageZoom from "react-image-zoom-hook";
8
9function DefaultZoomApp() {
10  /**
11
12* Necessary inputs for useImageZoomHook
13
14*/
15
16  /**
17
18* The ratio of lens height and width on main image and the zoom image also
19
20* should remain same for correct working.
21
22*/
23
24  const imgHeight = 600;
25
26  const imgWidth = 500;
27
28  const lensHeight = 100;
29
30  const lensWidth = 100;
31
32  const previewLensHeight = 600;
33
34  const img =
35    "https://rukminim1.flixcart.com/image/880/1056/jw6pifk0/t-shirt/e/v/z/m-61ywn-lewel-original-imafgxd7dfg7uub2.jpeg?q=50";
36
37  const previewImg =
38    "https://rukminim1.flixcart.com/image/880/1056/jw6pifk0/t-shirt/e/v/z/m-61ywn-lewel-original-imafgxd7dfg7uub2.jpeg?q=90";
39
40  const { DefaultView } = useImageZoom({
41    imgHeight,
42
43    imgWidth,
44
45    lensHeight,
46
47    lensWidth,
48
49    previewLensHeight,
50
51    img,
52
53    previewImg
54  });
55
56  /**
57
58* Two images are involved here, user need to have a actual image and
59
60* one good quality image with higher resolution
61
62*/
63
64  return <div className="container">{DefaultView}</div>;
65}

Customised Zoom

1/**
2
3 * Example of customised zooming
4
5*/
6import React from "react";
7import useImageZoom from "react-image-zoom-hook";
8
9function AppWithZoomCustomization() {
10  /**
11
12* Necessary inputs for useImageZoomHook
13
14*/
15
16  /**
17
18* The ratio of lens height and width on main image and the zoom image also
19
20* should remain same for correct working.
21
22*/
23
24  const imgHeight = 600;
25
26  const imgWidth = 500;
27
28  const lensHeight = 100;
29
30  const lensWidth = 100;
31
32  const previewLensHeight = 600;
33
34  const img =
35    "https://rukminim1.flixcart.com/image/880/1056/jw6pifk0/t-shirt/e/v/z/m-61ywn-lewel-original-imafgxd7dfg7uub2.jpeg?q=50";
36
37  const previewImg =
38    "https://rukminim1.flixcart.com/image/880/1056/jw6pifk0/t-shirt/e/v/z/m-61ywn-lewel-original-imafgxd7dfg7uub2.jpeg?q=90";
39
40  const {
41    moveLens,
42
43    imgDimesions,
44
45    lensDimensions,
46
47    previewLensDimensions,
48
49    previewImgDimensions,
50
51    imgContainerDimesions,
52
53    imgRefCallback,
54
55    meshRefCallback,
56
57    imagePreviewRefCallback
58  } = useImageZoom({
59    imgHeight,
60
61    imgWidth,
62
63    lensHeight,
64
65    lensWidth,
66
67    previewLensHeight,
68
69    img,
70
71    previewImg
72  });
73
74  /**
75
76* Two images are involved here, user need to have a actual image and
77
78* one good quality image with higher resolution
79
80*/
81
82  return (
83    <div className="container">
84      <div
85        className="img-main-container"
86        onMouseMove={moveLens}
87        style={{
88          ...imgContainerDimesions
89        }}
90      >
91        <div
92          ref={meshRefCallback}
93          className="mesh"
94          style={{
95            ...lensDimensions
96          }}
97        />
98
99        <img
100          style={{
101            ...imgDimesions
102          }}
103          ref={imgRefCallback}
104          alt="test"
105          src={img}
106        />
107      </div>
108
109      <div
110        className="img-preview-section-container"
111        // ref={imagePreviewRefContainer}
112
113        style={{
114          ...previewLensDimensions
115        }}
116      >
117        <img
118          ref={imagePreviewRefCallback}
119          alt="test-preview"
120          src={previewImg}
121          style={{
122            ...previewImgDimensions
123          }}
124          className="img-preview-section"
125        />
126      </div>
127    </div>
128  );
129}
130
131/**
132
133* Try to use both the types of image zoom
134
135* DefaultZoomApp : where you get the default zoom UI and also customizable
136
137* AppWithZoomCustomization: where user want to take control of different ui elements
138
139*/
140
141ReactDOM.render(<AppWithZoomCustomization />, document.getElementById("root"));

Type interface

Result attributes types

Gist for types above

Running the tests

1
2yarn run test
3

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

simbathesailor

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributors

Thanks goes to these wonderful people (emoji key):

_{Anil kumar Chaudhary}
💻 🤔 🎨 📖 🐛

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

133 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg
Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp
Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r
Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6
Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f
Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m
Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3
Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

2.5

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-image-zoom-hook

Other packages similar to react-image-zoom-hook

react-image-zoom-hook

Installations

Score

Pull Requests

36

57

20

1

Issues

0

0

0

Releases

Unable to fetch releases

Developer

Developer Guide

CommonJS

>=8

No

12.10.0

6.10.3

Statistics

Languages

Total Downloads

62,914

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

Image zoom react hook

Installing

Getting Started

Live Example

Default Zoom

Customised Zoom

Running the tests

Contributing

Versioning

Authors

License

Contributors

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10