A ScrollSpy library for detecting enter/exit of elements in the viewport when the user scrolls
Clone or download
thesmart Doc updates.
Manually merging @	Mithgol fixes
3
Latest commit 0ae1076 May 27, 2014
Permalink
Failed to load latest commit information.
example example Apr 26, 2013
.gitignore first version of scroll-spy Apr 26, 2013
LICENSE plugin manifest Apr 26, 2013
README.md Doc updates. May 27, 2014
scrollSpy.jquery.json Doc updates. May 27, 2014
scrollspy.js Doc updates. May 27, 2014

README.md

jquery-scrollspy

A jQuery plugin for detecting enter/exit of elements in the viewport when the user scrolls.

New Features

Added a couple new features:

  • May 2014 - optional window offset, allows for things like floating navs
  • Feb 2014 - supports window resize
  • Nov 2013 - throttles scrollspy events so that event handles only fire every 100 milliseconds

Usage

$('.tile').on('scrollSpy:enter', function() {
	console.log('enter:', $(this).attr('id'));
});

$('.tile').on('scrollSpy:exit', function() {
	console.log('exit:', $(this).attr('id'));
});

$('.tile').scrollSpy();

// or you could do this:
// $.scrollSpy($('.tile'));
// or this
// $('.tile').each(function(i, element) {
// 		$.scrollSpy(element);
// });

Window Resize

Use the scrollSpy:winSize event for watching window resize. This fires any time the window is resized by the user.

$.winSizeSpy().on('scrollSpy:winSize', funcy)

Contributions

Please provide pull requests for additional features. Test cases would be most weclome!

Thank you contributors: