Polyfill for the "History API: Scroll Restoration"
Switch branches/tags
Nothing to show
Clone or download

readme.md

scroll-restoration-polyfill

Prevent the scroll restoration caused by the popstate event or back/forward buttons. Demo

gzipped size Travis build status npm version

Warning: it works in Chrome, Safari, and Firefox 46+, but there's no IE/Edge support yet.

Usage

The polyfill has no API. Once included, just use the official API as described on Chrome Developers:

// Prevent the scroll, always
history.scrollRestoration = 'manual';

// Stop preventing the scroll
history.scrollRestoration = 'auto';

Install

Pick your favorite:

<script src="dist/scroll-restoration-polyfill.browser.js"></script>
npm install --save scroll-restoration-polyfill
require('scroll-restoration-polyfill');
import 'scroll-restoration-polyfill';

Links

Dependencies

Two lightweight dependencies, already included in scroll-restoration-polyfill's scroll-restoration-polyfill's gzipped size

License

MIT © Federico Brigante