Skip to content
React component to keep the scroll of the page and to restore it if the user clicks on the back button of its browser
JavaScript HTML
Branch: master
Clone or download
Latest commit 8cb9c1c Apr 18, 2019

README.md

Build Status

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

Apparently, it work with react router v5. I haven't test all feature. But it work in the exemple with the v5.

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

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

You can’t perform that action at this time.