Most routing libraries currently store the scroll position in the history state and manually restore it from there.

Advantages

• Programmatically read and manipulate the stored position
• Control over the exact point in time when to restore the scroll position
• No artificial separation between animated and non-animated (history) visits

Prior art

• Turbo: save to history
• pjax: save to history
• Astro: save to history
• Livewire: save to body attribute

Description

• Remember scroll position in history state
• Restore scroll position from history state
• Completely disable browser scroll restoration
• Create two hooks: scroll:store when saving position, scroll:restore when restoring position
  • Makes it extendable to support arbitrary scroll containers (to be managed by Scroll Plugin)
• Currently uses debounced scroll function to update position when scrolling stops
  • There is the new scrollend event but it's not 100% supported unfortunately and the polyfill is huge

To-do

• Restore scroll position on reload (maybe a Scroll Plugin feature?)
• Implement proper tests
• Check if this breaks anything and needs to move into v5

Checks

• The PR is submitted to the master branch
• The code was linted before pushing (npm run lint)
• All tests are passing (npm run test)
• New or updated tests are included
• The documentation was updated as required