Socket
Socket
Sign inDemoInstall

react-router-scroll-memory

Package Overview
Dependencies
8
Maintainers
1
Versions
29
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-router-scroll-memory

For React Router V4. React component to keep the scroll of the page and to restore it if the user clicks on the previous button of its browser


Version published
Maintainers
1
Weekly downloads
1,910
increased by5.52%

Weekly downloads

Readme

Source

Build Status

For React Router V4/V5. React component to keep the scroll of the page and to restore it if the user clicks on the previous button of its browser

You have solution in this page https://reacttraining.com/react-router/web/guides/scroll-restoration for just scrolling to top on navigation on every transition. But if you click on the previous button, the page is also at the top even if you had scrolled on the page.

I did this package because I was frustrated that the new react router (4) does not restore the scroll when I click on the back button of my browser. By default, the component execute window.scrollTo(0,0), if the url not exist in memory.

only work with react and react router v4 and v5

Npm page

https://www.npmjs.com/package/react-router-scroll-memory

Installation
  • install package

    $ npm i -S react-router-scroll-memory

  • import component in your main page.

import ScrollMemory from 'react-router-scroll-memory';
  • add the component after the Router.
  <BrowserRouter>
    <div>
      <ScrollMemory />
      <App />
    </div>
  </BrowserRouter>

New Feature

If you use your app inside a element, you can use props "elementID" for memorise scroll position of your element instead body scroll.

Tested on Browser:
  • Chrome
  • Explorer 11
  • Edge
  • Safari
  • Firefox
Online exemple

https://simple-react-app-with-router.stackblitz.io

Screenshots
  • Without the component The scroll keep the position on transition and the scroll of new page is not to top.

./without_scroll_memory

  • With the component The new page is top and if i click previous, the scroll is restored.

./with_scroll_memory

Keywords

FAQs

Last updated on 05 Aug 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc