A better, smoother, more performant window.onscroll event interface using requestAnimationFrame for performance and mobile-compatibility
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
test
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
bower.json
package.json

README.md

Jank-free onscrolling  Build Status

A better, smoother, more performant onscroll event interface based on the concepts from this html5rocks tutorial. It uses requestAnimationFrame plus debouncing for performance and mobile-compatibility (thanks to the touchmove event), giving you a fighting chance to achieve the hallowed 60fps of lore with your scroll-listening UI.

NPM

Usage

The module exports an onscrolling module if being used with a CommonJS or AMD module loader, or else exposes a global object as window.onscrolling.

onscrolling( callback )

callback function

The function to call on a scroll event. In this default version, the module will only call the callback() when the page has been scrolled vertically. It will be passed the current vertical scroll position to the callback.

onscrolling( direction, callback )

direction string

The scroll axis to monitor. Values can be x or horizontal to trigger when page is scrolled horizontally, or any to trigger when page is scrolled in any direction.

callback function

The function to call when the page is scrolled. It will be passed the current horizontal scroll position to the callback if listening for scrollX changes, or an array [x,y] if callback is listening for any scroll change.

onscrolling.remove( fn )

fn function

The function to remove from the onscroll handler. In this default version, the function will be removed from the vertical scroll queue.

onscrolling.remove( direction, fn )

direction string

The scroll axis that fn was listening for. Can be x or horizontal, or any, however the function was originally attached. If a function was attached to multiple scroll directions, you can remove only one of those listeners by calling this once for that direction.

fn function

The function to remove from the onscroll handler for the specified direction.

Dependencies

None.

Compatibility

Out of the box, onscrolling uses requestAnimationFrame, which is only available in IE10+. For older browsers, your scroll watchers simply won’t run. To add compatibility for those browsers, just include a requestAnimationFrame polyfill.

Tests

Tests use Mocha + Should.js + Sinon. Using npm test will run the tests in PhantomJS, but you can also open test/index.html directly in a browser.

TODO

  • Add optional param to specify an object other than window to monitor for scroll events
  • Expose measure and mutate functions to attach handlers specifically to the measuring (read) or mutating (write) portion of each cycle to minimize layout calculations

Misc

Note: This package was formerly known as jank-free-onscroll