https://github.com/thesmart/jquery-scrollspy
A ScrollSpy library for detecting enter/exit of elements in the viewport when the user scrolls
https://github.com/thesmart/jquery-scrollspy
Last synced: 5 months ago
JSON representation
A ScrollSpy library for detecting enter/exit of elements in the viewport when the user scrolls
- Host: GitHub
- URL: https://github.com/thesmart/jquery-scrollspy
- Owner: thesmart
- License: other
- Created: 2013-04-26T00:19:49.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2016-08-20T19:00:18.000Z (over 9 years ago)
- Last Synced: 2025-10-22T19:59:44.342Z (5 months ago)
- Language: JavaScript
- Size: 354 KB
- Stars: 275
- Watchers: 12
- Forks: 98
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-frontend - jquery-scrollspy(2)
- awesome-frontend - jquery-scrollspy(2)
- awesome-front-end - jquery-scrollspy(2)
README
# 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
```js
$('.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:
* [@Mithgol](https://github.com/Mithgol)
* [@eithanshavit](https://github.com/eithanshavit)