Web Totals
Scroll Restoration in Nextjs

Scroll Restoration in Nextjs

hunghg255

|

#Experimental scroll restoration flag

Luckily, Next.js has an experimental scrollRestoration flag that you can enable to automatically restore the scroll positions.

You can enable it in your next.config.js file this way:

next.config.js
module.exports = {
  experimental: {
    scrollRestoration: true,
  },
};
js

#next-router-scroll

There are some cases where you need to take control of how your application scroll is handled; namely, you may want to restore scroll when the user is navigating within your application pages, but you need to do extra work before or after the page has changed, either by using some sort of page transition or any other feature. In these cases, I’d suggest you give @moxy/next-router-scroll a try: This package is built on top of scroll-behavior and it actively listens to Next.js router events, writing the scroll values associated with the current location in the Session Storage and reading these values whenever updateScroll() is called.

#Completely disabling scroll restoration

There’s one inconsistency I noticed around not making scroll restoration work automatically in Next.js: by default, scroll restoration doesn’t work when the navigation logic is being handled by JavaScript, but it works fine when it’s handled by the browser (e.g.: on a full-refresh or while navigating with JavaScript disabled).

So, in the rare occasions where you want to fully disable scroll restoration, remember to add this snippet to the <head> of your project:

import Head from 'next/head';

export default function ScrollRestorationDisabler() {
  return (
    <Head>
      {/* Tell the browser to never restore the scroll position on load */}
      <script
        dangerouslySetInnerHTML={{
          __html: `history.scrollRestoration = "manual"`,
        }}
      />
    </Head>
  );
}
tsx