https://github.com/ctnicholas/next-restore-scroll
A fix for restoring scroll position with Next Router when the body element is not used as the main scrolling element.
https://github.com/ctnicholas/next-restore-scroll
Last synced: 4 months ago
JSON representation
A fix for restoring scroll position with Next Router when the body element is not used as the main scrolling element.
- Host: GitHub
- URL: https://github.com/ctnicholas/next-restore-scroll
- Owner: CTNicholas
- Created: 2021-05-24T15:34:56.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-16T10:29:10.000Z (almost 5 years ago)
- Last Synced: 2025-06-24T21:08:34.123Z (12 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# next-restore-scroll
After switching routes in [Next.js](https://github.com/vercel/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
```shell
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:
```jsx
import restoreScrollPosition from 'next-restore-scroll'
export default function App ({ Component, pageProps, router }) {
restoreScrollPosition(router, '#scrolling-element')
return (
...
)
}
```
Anywhere else:
```jsx
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 :
```js
restoreScrollPosition(router, '#scrolling-wrapper')
```
Restore scroll position of multiple elements:
```js
restoreScrollPosition(router, ['#scrolling-wrapper', '#scrolling-panel'])
```
Restore scroll position of multiple elements retrieved with the same selector:
```js
restoreScrollPosition(router, '.scrolling-element', true)
```
Restore scroll position of a mixture of elements:
```js
restoreScrollPosition(router, ['#scrolling-wrapper', '.scrolling-element', '.scrolling-box'], true)
```
### Syntax
```js
restoreScrollPosition(router, elementSelectors[, selectMultipleOfElement[, restoreOnNew]])
```
- router
- The next/router object. Can be retrieved with useRouter().
- elementSelectors
- String or string array. The CSS selectors for the scrolling element(s).
- selectMultipleOfElement (optional)
- Boolean, default is false. If true, querySelectorAll will be used, instead of querySelector, and multiple elements selected by the same selector will have their position restored, instead of just the first.
- restoreOnNew (optional)
- Boolean, default is false. When revisiting a page with a scroll position, without navigating via the back/forward buttons, restore the scroll position from history.