README

skrollTop.js

preview">

| 0.4Kb gziped | Created by @imac2

Introduction

Why another smooth scrolling library? Don't we have enough? Indeed we do! And some are great in fact! But I didn't need such a big amount of code for my simple purpose of using scrollTop programmatically. This is only 400 bytes minified!

This library reduces the code to the bare minimum and still provides some nice features such as:

Callback on finish.
Optionally scroll a different element than the window.
Use different easings as jQuery UI did in the past.
Stop animation programmatically.

Installation

Optionally, you can install skrollTop.js with bower or npm if you prefer:

// With bower
bower intall skrolltop

// With npm
npm intall skrolltop

Usage

The basic usage would be:

skrollTop.scrollTo({
    to: 800
});

Another example with all parameters would be as follows:

skrollTop.scrollTo({
    element: window,
    to: 800,
    easing: window.easings.easeOutBounce,
    duration: 600,
    callback: function() {
       console.log("finished!");
    }
});

Stop animation at any moment

You can stop the animation in course by calling:

skrollTop.stop();

Using easing effects

By default the library includes the easeInOutCubic easing effect. If you wish to make use of any other, you can make use of the vendor file easings.js and pass the easing function to the skroll library whenever you call it:

skrollTop.scrollTo({
   element: window,
   to: 800,
   easing: window.easings.easeOutBounce // <-- here
});

Donations

Donations would be more than welcome :)

License

The credit comments in the JavaScript and CSS files should be kept intact (even after combination or minification )

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!