npmpackage.info

react-router-hash-link

Hash link scroll functionality for React Router

2.4.3

734

MIT

JavaScript

1.18 kB

40,986,869 1.7

Installations

npm install react-router-hash-link

Score

57.9

Supply Chain

92.6

Quality

75.8

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

1

Total

29

Closed

18

Merged

10

Issues

Open

19

Total

80

Closed

61

Releases

v2.4.3

Published on 13 May 2021

v2.4.2

Published on 13 May 2021

v2.4.1

Published on 04 May 2021

v2.4.0

Published on 11 Feb 2021

v2.3.0

Published on 09 Dec 2020

v2.2.0

Published on 09 Oct 2020

View all 18 releases

Developer

rafgraph

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

16.1.0

NPM Version

7.11.2 Statistics

734 Stars

111 Commits

62 Forks

10 Watching

4 Branches

7 Contributors

Updated on 01 Nov 2024

Bundle Size

2.47 kB

Minified

1.18 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (97.74%)

TypeScript (2.26%)

Total Downloads

Cumulative downloads

Total Downloads

40,986,869

Last day

33,627

Compared to previous day

Last week

4.8%

186,806

Compared to previous week

Last month

-1.4%

798,291

Compared to previous month

Last year

-0.1%

10,400,699

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

React Router Hash Link

This is a solution to React Router's issue of not scrolling to #hash-fragments when using the <Link> component to navigate.

When you click on a link created with react-router-hash-link it will scroll to the element on the page with the id that matches the #hash-fragment in the link. This will also work for elements that are created after an asynchronous data load. Note that you must use React Router's BrowserRouter for this to work.

Live demo app for React Router Hash Link

Code is in the /demo folder, or open the demo in CodeSandbox

Basics

1npm install --save react-router-hash-link

react-router-dom is a peer dependency.

`<HashLink>`

1import { HashLink } from 'react-router-hash-link';
2
3...
4
5// use it just like a RRv4/5 <Link>
6// the `to` prop can be a string or an object, see RRv4/5 api for details
7<HashLink to="/some/path#with-hash-fragment">Link to Hash Fragment</HashLink>

`<NavHashLink>`

1import { NavHashLink } from 'react-router-hash-link';
2
3...
4
5// use it just like a RRv4/5 <NavLink> (see RRv4/5 api for details)
6// it will be active only if both the path and hash fragment match
7<NavHashLink
8  to="/some/path#with-hash-fragment"
9  activeClassName="selected"
10  activeStyle={{ color: 'red' }}
11  // etc...
12>Link to Hash Fragment</NavHashLink>

Scrolling API

`smooth: boolean`

Smooth scroll to the element
React Router Hash Link uses the native Element method element.scrollIntoView() for scrolling, and when the smooth prop is present it will call it with the smooth option, element.scrollIntoView({ behavior: 'smooth' })
Note that not all browsers have implemented options for scrollIntoView - see MDN and Can I Use - there is also a browser polyfill for smooth scrolling which you can install separately so smooth will work in all browsers

1import { HashLink } from 'react-router-hash-link';
2
3...
4
5<HashLink smooth to="/path#hash">
6  Link to Hash Fragment
7</HashLink>;

`scroll: function`

Custom scroll function called with the element to scroll to, e.g. const myScrollFn = element => {...}
This allows you to do things like scroll with offset, use a specific smooth scrolling library, or pass in your own options to scrollIntoView

1import { HashLink } from 'react-router-hash-link';
2
3...
4
5<HashLink
6  to="/path#hash"
7  scroll={(el) => el.scrollIntoView({ behavior: 'auto', block: 'end' })}
8>
9  Link to Hash Fragment
10</HashLink>;

Scroll to top of page

To scroll to the top of the page set the hash fragment to # (empty) or #top
This is inline with the HTML spec, also see MDN

1import { HashLink } from 'react-router-hash-link';
2
3...
4
5<HashLink to="/path#top">Link to Top of Page</HashLink>
6// or
7<HashLink to="#top">Link to Top of Page</HashLink>

Scroll with offset

To scroll with offset use a custom scroll function, one way of doing this can be found here

`elementId: string`

Scroll to the element with matching id
Used instead of providing a hash fragment as part of the to prop, if both are present then the elementId will override the to prop's hash fragment
Note that it is generally recommended to use the to prop's hash fragment instead of the elementId

Custom `Link`

The exported components are wrapped versions of the Link and NavLink exports of react-router-dom. In some cases you may need to provide a custom Link implementation.

For example, the gatsby static site generator requires you to use its implementation of Link. You can wrap it with the genericHashLink function of this package.

1import { genericHashLink } from 'react-router-hash-link';
2import GatsbyLink from 'gatsby-link';
3
4const MyHashLink = genericHashLink(GatsbyLink);
5
6const MyComponent = () => (
7  <div>
8    The default wont work for you?
9    <MyHashLink to="/faq#how-to-use-custom-link">No problem!</MyHashLink>
10  </div>
11);

Focus Management

react-router-hash-link attempts to recreate the native browser focusing behavior as closely as possible.

The browser native behavior when clicking a hash link is:

If the target element is not focusable, then focus is moved to the target element, but the target element is not focused.
If the target element is focusable (interactive elements and elements with a tabindex), then the target element is focused.

To recreate this react-router-hash-link does the following:

For non-focusable elements, it calls element.focus() followed by element.blur() (using a temporary tabindex to ensure that the element can be focused programmatically) so that focus moves to the target element but does not remain on it or trigger any style changes.
For focusable elements, it calls element.focus() and leaves focus on the target element.

Note that you may find it useful to leave focus on non-interactive elements (by adding a tabindex of -1) to augment the navigation action with a visual focus indicator.

No vulnerabilities found.

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

Code-Review

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

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

117 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
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-qwcr-r2fm-qrc7
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-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
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-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-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
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-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-qrpm-p2h7-hrv2
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-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
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-gcx4-mw62-g8wm
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-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-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
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-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-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-7f5c-rpf4-86p8
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-r8f7-9pfq-mjmv
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-3965-hpx2-q597
Warn: Project is vulnerable to: GHSA-35q2-47q7-3pc3
Warn: Project is vulnerable to: GHSA-7mwh-4pqv-wmr8
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-wv8q-r932-8hc7
Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-rjf2-j2r6-q8gr
Warn: Project is vulnerable to: GHSA-6pw2-5hjv-9pf7
Warn: Project is vulnerable to: GHSA-4w2j-2rg4-5mjw
Warn: Project is vulnerable to: GHSA-mrgp-mrhc-5jrq
Warn: Project is vulnerable to: GHSA-7jxr-cg7f-gpgv
Warn: Project is vulnerable to: GHSA-xj72-wvfv-8985
Warn: Project is vulnerable to: GHSA-ch3r-j5x3-6q2m
Warn: Project is vulnerable to: GHSA-p5gc-c584-jj6v
Warn: Project is vulnerable to: GHSA-whpj-8f3w-67p5
Warn: Project is vulnerable to: GHSA-cchq-frgv-rjh5
Warn: Project is vulnerable to: GHSA-g644-9gfx-q4q4
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg

Score

1.7

/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-router-hash-link

@types/react-router-hash-link

2.4.9

TypeScript definitions for react-router-hash-link

@xzar90/react-router-hash-link

6.0.4

Hash link scroll functionality for React Router v6

react-router

7.0.1

Declarative routing for React

react-router-redux

4.0.8

Ruthlessly simple bindings to keep react-router and redux in sync

react-router-hash-link

Installations

Score

Pull Requests

1

29

18

10

Issues

19

80

61

Releases

Developer

Developer Guide

CommonJS

No

16.1.0

7.11.2

Statistics

Bundle Size

2.47 kB

1.18 kB

Languages

Total Downloads

40,986,869

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

React Router Hash Link

Live demo app for React Router Hash Link

Basics

<HashLink>

<NavHashLink>

Scrolling API

smooth: boolean

scroll: function

Scroll to top of page

Scroll with offset

elementId: string

Custom Link

Focus Management

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to react-router-hash-link

`<HashLink>`

`<NavHashLink>`

`smooth: boolean`

`scroll: function`

`elementId: string`

Custom `Link`