Waypoints is a library that makes it easy to execute a function whenever you scroll to an element.
Branch: master
Clone or download
Latest commit 34d9f6d Sep 3, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib 4.0.1 Sep 3, 2016
src Ensure a window context always exists Jul 10, 2016
test Ensure a window context always exists Jul 10, 2016
.eslintrc Set up lint rules, follow them Jun 20, 2014
.gitignore Ignore leftover pages builds Dec 17, 2014
.travis.yml Travis container config Aug 18, 2015
CHANGELOG.md 4.0.1 Sep 3, 2016
CONTRIBUTING.md Contribution guidelines Dec 19, 2014
README.md Update README.md Jan 21, 2015
bower.json Remove moot `version` property from bower.json Jun 10, 2015
gulpfile.js Fix typos Sep 10, 2015
licenses.txt Eff the GPL Jan 2, 2013
package.json 4.0.1 Sep 3, 2016
testem.json Debug script Dec 12, 2014

README.md

Waypoints

Waypoints is a library that makes it easy to execute a function whenever you scroll to an element. Build Status

var waypoint = new Waypoint({
  element: document.getElementById('thing'),
  handler: function(direction) {
    alert('You have scrolled to a thing')
  }
})

If you're new to Waypoints, check out the Getting Started guide.

Read the full documentation for more details on usage and customization.

Shortcuts

In addition to the normal Waypoints script, extensions exist to make common UI patterns just a little easier to implement:

Contributing

If you want to report a Waypoints bug or contribute code to the library, please read the Contributing Guidelines. If you need help using Waypoints, please do not open an issue. Instead, ask the question on Stack Overflow and tag it with #jquery-waypoints. Be sure to follow the guidelines for asking a good question.

License

Copyright (c) 2011-2014 Caleb Troughton. Licensed under the MIT license.