https://github.com/epicweb-dev/restore-scroll
🌀 Restore scroll position of elements on page navigation
https://github.com/epicweb-dev/restore-scroll
Last synced: about 2 months ago
JSON representation
🌀 Restore scroll position of elements on page navigation
- Host: GitHub
- URL: https://github.com/epicweb-dev/restore-scroll
- Owner: epicweb-dev
- Created: 2023-11-28T20:47:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T04:02:14.000Z (9 months ago)
- Last Synced: 2025-03-31T23:37:24.364Z (3 months ago)
- Language: TypeScript
- Homepage: https://github.com/epicweb-dev/restore-scroll
- Size: 24.4 KB
- Stars: 256
- Watchers: 2
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🌀 @epic-web/restore-scroll
Restore scroll position of elements on page navigation
The <body> isn't the only thing that scrolls. When the user scrolls a list, then navigates back and forth, you may want to keep their scroll position where it was when they left. This library makes that easy.
```
npm install @epic-web/restore-scroll
```
[![Build Status][build-badge]][build]
[![MIT License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
## The Problem
When a user navigates to a new page, the browser will scroll the page to the
position it was at when the user left the page. This is a great feature, but
it's not perfect. The browser only scrolls the `` element. If the user
scrolls a list, then navigates back and forth, the browser will scroll the page
to the top, but the list will still be scrolled to the position it was at when
the user left the page.
## The Solution
This library provides a way to restore the scroll position of any element on the
page you choose. It does this by storing the scroll position of the element in
session storage and then restoring it when the user navigates back to the page
(very similar to how Remix handles scroll restoration for the ``).
This depends on React Router's `useNavigation` and `useLocation` hooks. It could
probably be generalized to work with other routers. PRs welcome.
## Demo
[](https://stackblitz.com/edit/remix-run-remix-fczany?file=app%2Froutes%2F_index.tsx)
Note: this demo is based on Remix, but will work with React Router as well.
## Usage
```tsx
import { ElementScrollRestoration } from '@epic-web/restore-scroll'
return (
- 🎁
- 🎂
- 🎉
{/* ... */}
)
```
And that's it! Now when the user navigates away from the page and then back to
it, the list will be scrolled to the position it was at when the user left the
page.
You can also specify horizontal scroll for elements like carousels:
```tsx
```
## Tips:
1. This requires an inline script, so you'll need to pass a `nonce` if you're
using a Content Security Policy that requires this.
2. Make certain to place the `ElementScrollRestoration` component _after_ the
element you want to restore the scroll position of. This is because the
component will render a `` tag immediately after the element, and
that script will run immediately, so the element needs to be in the DOM
before the script runs.
3. If you're computing the `id` and that value can change between navigations,
you may need to specify a `key` on `ElementScrollRestoration` to trigger the
inline script to be evaluated again and set the scroll position correctly.
4. You'll want one of these components for each scrollable element you want to
restore the scroll position for.
## License
MIT
<!-- prettier-ignore-start -->
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/restore-scroll/release.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/restore-scroll/actions?query=workflow%3Arelease
[license-badge]: https://img.shields.io/badge/license-MIT%20License-blue.svg?style=flat-square
[license]: https://github.com/epicweb-dev/restore-scroll/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct
<!-- prettier-ignore-end -->