Noteworthy Programming Masterpiece

    smoothscroll-polyfill
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/smoothscroll-polyfill package

    0.4.4 • Public • Published

    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 Chrome, Firefox and Opera.

    Check out all the methods covered here: https://iamdustan.github.io/smoothscroll

    Installation and use

    Download the production ready file here and include it in your project, or install it as a package.

    # npm 
    npm install smoothscroll-polyfill --save
     
    # yarn 
    yarn add smoothscroll-polyfill

    When including the polyfill in a script tag, it will run immediately after loaded.

    If you are importing it as a dependency, make sure to call the polyfill method:

    import smoothscroll from 'smoothscroll-polyfill';
     
    // kick off the polyfill!
    smoothscroll.polyfill();

    In both cases, the script will detect if the spec is natively supported and take action only when necessary.

    The code requires requestAnimationFrame polyfill for browsers which don't support it.

    Force polyfill implementation

    If you prefer to always override the native scrolling methods, place this global variable before requiring the module or including the polyfill file.

    window.__forceSmoothScrollPolyfill__ = true;

    We strongly recommend not to do this unless your project strongly needs it.

    Contribute

    The requirements to contribute are yarn and the latest LTS Node.js version.

    First, fork the repository and do yarn install in the root folder to get all the dependencies to work with. Create a feature branch, write your stuff and run yarn test to check code style and prevent bugs.

    In this project we use Prettier to format the final published code, you can run yarn format before committing. If you don't, a precommit hook will prevent you from pushing code that hasn't been formatted properly.

    Are you done? Awesome, submit a pull request explaining your changes.

    This is a polyfill, not library, so make sure the behavior you are introducing is in the spec.

    On tests files we are using ES2015, but the polyfill is written in ES5 for browser compatibility.

    Watch tests

    If you want to watch tests as you write your code run yarn test --watch.

    Browser Support

    Successfully working in:

    • natively supported in Chrome
    • natively supported in Firefox
    • Safari 6+
    • Internet Explorer 9+
    • Microsoft Edge 12+
    • Opera Next

    Standards documentation

    Install

    npm i smoothscroll-polyfill

    DownloadsWeekly Downloads

    493,475

    Version

    0.4.4

    License

    MIT

    Unpacked Size

    145 kB

    Total Files

    7

    Last publish

    Collaborators

    • iamdustan
    • jeremenichelli
    • jiyinyiyong