Gathering detailed insights and metrics for react-viewport-utils
Gathering detailed insights and metrics for react-viewport-utils
Installations
npm install react-viewport-utilsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
^8.9.0 || >= 10.13.0
Node Version
16.12.0
NPM Version
8.1.0
Score
63.2
Supply Chain
92.9
Quality
76.2
Maintenance
100
Vulnerability
99.6
License
Releases
33
Contributors
5
Unable to fetch Contributors
Languages
2
TypeScript
JavaScript
TypeScript (98.64%)
JavaScript (1.36%)
Developer
garthenweb
Download Statistics
Total Downloads
536,646
Last Day
43
Last Week
1,088
Last Month
7,021
Last Year
81,440
GitHub Statistics
18 Stars
236 Commits
7 Forks
4 Watching
11 Branches
5 Contributors
Maintainers
1
Package Meta Information
Latest Version
2.0.2
Package Id
react-viewport-utils@2.0.2
Unpacked Size
5.04 MB
Size
2.09 MB
File Count
382
NPM Version
8.1.0
Node Version
16.12.0
Total Downloads
Cumulative downloads
Total Downloads
536,646
Last day
-81%
43
Compared to previous day
Last week
4.4%
1,088
Compared to previous week
Last month
16%
7,021
Compared to previous month
Last year
-25.4%
81,440
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Versions
React Viewport Utils
A set of low level utility components for react to make working with the viewport (e.g scroll position or size of the page) easy to use and performant by default.
See the example folder for more information about what you can build with it.
Why?
On a website with more sophisticated user interactions a lot of components need access to viewport information to e.g. know whether they are in the viewport, should resize or trigger an animation.
Most of the libraries reimplement the required functionality for that kind of features on its own over and over again. Those functionalities are not just hard to implement but can also, if not done well, cause the UX to suffer by introducing layout thrashing and therefore jank and will also cause the bundle size to grow which reduce the time to interaction. Further its hard to prioritize between highly and less important events if the implementation is not bundled in one central position.
This library solves all those issues by
- using one central event handler per event to collect data
- triggers updates to components using request animation frame
- allows to prioritize the importance of updates at runtime which allows to drop frames for less important updates in case the main thread is busy
- implements patterns like
onUpdatecallbacks, render props, higher order components and hooks which make the developer experience as simple as possible and allows the developer to concentrate on the application and not on global event handling.
Installation/ requirements
Please note that react version 16.3 or higher is required for this library to work because it is using the context as well as references api.
npm install --save react-viewport-utils
By default the library ships with Typescript definitions, so there is no need to install a separate dependency. Typescript is no a requirement, all type definition are served within separate files.
For detection of some resize events the ResizeObserver API is used internally which is not supported in some browsers. Please make sure to implement a polyfill on your own in case its required for your application.
Supported Environments
Browsers
The goal is to support the most recent versions of all major browsers (Edge, Safari, Chrome and Firefox).
We try to be downward compatible with older browsers when possible to at least not throw errors, but older versions will not be test at all.
In case you have specific requirements, please fill an issue or create a PR so we can discuss about them.
NodeJS
The project aims to support recent releases of v8 and v10 and higher of NodeJS.
Documentation
API
ViewportProviderObserveViewportconnectViewportuseViewportuseMutableViewportuseScrolluseDimensionsuseLayoutSnapshotuseViewportEffectuseScrollEffectuseDimensionsEffectuseRectuseRectEffect- Types
Concepts
License
Licensed under the MIT License.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 2/28 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 4 are checked with a SAST tool
Reason
43 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- 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-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-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- 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-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-7hpj-7hhx-2fgx
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- 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-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-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
1.7
/10
Last Scanned on 2024-12-16
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