npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

next-restore-scroll

v1.2.1

Published

A fix for restoring scroll position with Next Router when the body element is not used as the main scrolling element.

Downloads

116

Readme

next-restore-scroll

After switching routes in Next.js, via the forward and back buttons, the scroll position can be lost. This is often because only the body tag will have its position restored, and sometimes the main scrolling window is another element. This package can fix this, and it can also restore the scroll position of any other elements in the page, after using dynamic next/router links.

How it works

next-restore-scroll simply saves the scroll position of the chosen element(s) in sessionStorage before the next router page is changed, and then applies the scroll position after the route has loaded.

Install

npm install next-restore-scroll

How to use

This package can be used in any React component, though I'd advise only using it once per project, and adding all scrollable elements to the second argument.

_app.js:

import restoreScrollPosition from 'next-restore-scroll'

export default function App ({ Component, pageProps, router }) {
  restoreScrollPosition(router, '#scrolling-element')
  return (
    ...
  )
}

Anywhere else:

import { useRouter } from 'next/router'
import restoreScrollPosition from 'next-restore-scroll'

export default function Layout () {
  const router = useRouter()
  restoreScrollPosition(router, '#scrolling-element')
  return (
    ...
  )
}

Examples

Restore scroll position of one element :

restoreScrollPosition(router, '#scrolling-wrapper')

Restore scroll position of multiple elements:

restoreScrollPosition(router, ['#scrolling-wrapper', '#scrolling-panel'])

Restore scroll position of multiple elements retrieved with the same selector:

restoreScrollPosition(router, '.scrolling-element', true)

Restore scroll position of a mixture of elements:

restoreScrollPosition(router, ['#scrolling-wrapper', '.scrolling-element', '.scrolling-box'], true)

Syntax

restoreScrollPosition(router, elementSelectors[, selectMultipleOfElement[, restoreOnNew]])