npmpackage.info

Gathering detailed insights and metrics for react-smooth-scroll-hook

Other packages similar to react-smooth-scroll-hook

scroll-into-view-if-needed

3.1.0

Ponyfill for upcoming Element.scrollIntoView() APIs like scrollMode: if-needed, behavior: smooth and block: center

react-infinite-scroll-hook

5.0.1

A simple hook to create infinite scroll components

smooth-scroll-into-view-if-needed

2.0.2

Ponyfill for smooth scrolling elements into view (if needed!)

react-scroll-to-bottom

4.2.0

React container that will auto scroll to bottom

Gathering detailed insights and metrics for react-smooth-scroll-hook

react-smooth-scroll-hook

A React Hook for using smooth scroll in React Component

1.3.4

117

MIT

TypeScript

2.02 kB

545,131 2.5

Installations

npm install react-smooth-scroll-hook

Pull Requests

Open

0

Total

11

Closed

0

Merged

11

Issues

Open

2

Total

3

Closed

1

Releases

v1.3.4

Published on 27 Oct 2020

v1.3.3

Published on 29 Aug 2020

v1.3.2

Published on 28 Aug 2020

v1.3.1

Published on 28 Aug 2020

v1.3.0

Published on 27 Aug 2020

v1.2.0

Published on 25 Aug 2020

View all 9 releases

Developer

ron0115

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

No

Node Version

12.19.0

NPM Version

6.14.8 Statistics

117 Stars

84 Commits

5 Forks

3 Watching

3 Branches

2 Contributors

Updated on 21 Oct 2024

Bundle Size

5.13 kB

Minified

2.02 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (93.08%)

JavaScript (5.58%)

HTML (1.23%)

CSS (0.1%)

Total Downloads

Cumulative downloads

Total Downloads

545,131

Last day

3.9%

322

Compared to previous day

Last week

-6.1%

1,506

Compared to previous week

Last month

5.8%

6,646

Compared to previous month

Last year

-53.1%

81,140

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

react-smooth-scroll-hook

Powered By GE-COMPONENTS From YY GFE TEAM

English | 简体中文

It provided useSmoothScroll hook for finishing smooth scroll behaviour in react component, and useScrollWatch to return some information in scroll container.

It 's a more convenient way to replace native scrollTo api.

Storybook Docs are Here.

Feature

🚀 You don't need to warn about compatibility, it use requsetAnimationFrame api to finish smooth scroll behaviour.
👉 Provide direction option ,you can set x for horizontal, y for vertical.
💧 No Third Party dependencies, light and pure.

Installation

1npm install react-smooth-scroll-hook

useSmoothScroll

Quick Start

1import React, { useRef } from 'react';
2import useSmoothScroll from 'react-smooth-scroll-hook';
3export const Demo = () => {
4  // A custom scroll container
5  const ref = useRef(null);
6
7  // Also support document.body / document.documentElement, and you don't need to set a ref passing to jsx
8  const ref = useRef(document.body);
9
10  const { scrollTo } = useSmoothScroll({
11    ref,
12    speed: 100,
13    direction: 'y',
14  });
15
16  return (
17    <>
18      <button onClick={() => scrollTo('#item-20')}>scrollTo('#item-20')</button>
19      <div
20        // if use custom scroll container, pass ref
21        ref={ref}
22        style={{
23          overflowY: 'scroll',
24          maxHeight: '200px',
25        }}
26      >
27        {Array(100)
28          .fill(null)
29          .map((_item, i) => (
30            <div key={i} id={`item-${i}`}>
31              item-{i}
32            </div>
33          ))}
34      </div>
35    </>
36  );
37};

Props

ref: RefObject<HTMLElement>, container which set as overflow: scroll, if scroll whole document, pass ref = useRef(document.documentElement) or useRef(document.body).
speed: Distance in one frame to move in requestAnimationFrame mode, defaults to 100, if not provide, speed depends on native API scrollTo.
direction: Scroll direction, x for horizontal or y for vertical.
threshold: an error range distance for status of scrolling finished, .defaults to 1, unit of px.

Returns of Hook

scrollTo (string|number) => void
- Pass number: the distance to scroll, e.g. scrollTo(400)
- Pass string: the element seletor you want to scrollTo, meanwhile passing to document.querySelector, e.g. scrollTo('#your-dom-id')
reachedTop boolean: Whether it has reached the top of refContainer
reachedBottom boolean: Whether it has reached the bottom of refContainer

Demo

CodeSandbox
Storybook

useScrollWatch

Proviede a list of dom like below, and pass the parent container ref to hook, it return the scrollbar current state of scrollTop, curIndex, curItem.

Quick Start

1import React, { useRef } from 'react';
2import { useScrollWatch } from 'react-smooth-scroll-hook';
3export const ScrollConatainerMode = () => {
4  const ref = useRef(null);
5  const { scrollTop, curIndex, curItem } = useScrollWatch({
6    ref,
7    list: [
8      {
9        href: '#item-0',
10      },
11      {
12        href: '#item-10',
13      },
14      {
15        href: '#item-20',
16      },
17    ],
18  });
19  return (
20    <>
21      <h2>Scroll Container Mode</h2>
22      <div>
23        <p>
24          <strong>scrollTop:</strong> {scrollTop}
25        </p>
26        <p>
27          <strong>curIndex:</strong> {curIndex}
28        </p>
29        <p>
30          <strong>curHref:</strong> {curItem?.href}
31        </p>
32      </div>
33      <div
34        style={{
35          padding: '10px',
36          maxHeight: '200px',
37          overflowY: 'scroll',
38        }}
39        ref={ref}
40      >
41        {Array(100)
42          .fill(null)
43          .map((_item, i) => (
44            <div key={i} id={`item-${i}`}>
45              item-{i}
46            </div>
47          ))}
48      </div>
49    </>
50  );
51};

Props

list Array({href, offset}): href is elemet selector string, which passing to querySelector, such as #element-id
ref: the same as ref of useSmoothScroll

Returns of Hook

scrollTop number: current scrollTop of scroll container.
curIndex number: current Index of list
curItem {href, offset}: current Item of list

Demo

CodeSandbox
Storybook

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

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

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

118 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
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-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-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
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-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-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
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-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
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-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
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-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-4wx3-54gh-9fr9
Warn: Project is vulnerable to: GHSA-4r62-v4vq-hr96
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc / GHSA-xgh6-85xh-479p
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-wvhm-4hhf-97x9
Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w
Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
Warn: Project is vulnerable to: GHSA-3949-f494-cm99
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
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-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-mpwj-fcr6-x34c

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-smooth-scroll-hook

Other packages similar to react-smooth-scroll-hook

react-smooth-scroll-hook

Installations

Pull Requests

0

11

0

11

Issues

2

3

1

Releases

Developer

Developer Guide

CommonJS

>=10

No

12.19.0

6.14.8

Statistics

Bundle Size

5.13 kB

2.02 kB

Languages

Total Downloads

545,131

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

react-smooth-scroll-hook

Feature

Installation

useSmoothScroll

Quick Start

Props

Returns of Hook

Demo

useScrollWatch

Quick Start

Props

Returns of Hook

Demo

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10