node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

smoothscroll-polyfill

Smooth Scroll behavior polyfill

The Scroll Behavior specification has been introduced as an extension of the Window interface to allow for the developer to opt in to native smooth scrolling. To date this has only been implemented in Firefox.

See it in action https://iamdustan.github.io/smoothscroll

Install

Download the distribution file from this repository and include it in your project.

You can also find it in npm as smoothscroll-polyfill or bower as smoothscroll.

require('smoothscroll-polyfill').polyfill();

Requires requestAnimationFrame polyfill for browsers which don't support it!

Force polyfill implementation

If you prefer the polyfill to always override the current native methods (sometimes needed because of parcial implementations or inconsistencies between browsers), place this global variable before requiring the module or including the polyfill file.

window.__forceSmoothScrollPolyfill__ = true;

Contribute

Fork the repository and run npm install.

After any modification make sure it doesn't break in any of the supported browsers, check linting and build running npm run build and then open a pull request.

Browser Support

Successfully tested in:

  • Safari 6+
  • iOS Safari 6+
  • Chrome (last version)
  • natively supported in Firefox
  • Internet Explorer 9+
  • Microsoft Edge
  • Opera Next

If you have tested this and worked as expected in a different browser let us know so we can add it to the list, if not open an issue providing browser, browser version and a good description about it.

Standards documentation