Permalink
Fetching contributors…
Cannot retrieve contributors at this time
39 lines (24 sloc) 1.85 KB

jQuery Waypoints

Waypoints is a jQuery plugin that makes it easy to execute a function whenever you scroll to an element.

$('.thing').waypoint(function() {
  alert('You have scrolled to a thing.');
});

If you're new to Waypoints, check out the Get Started section.

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:

Examples

Waypoints can also be used as a base for your own custom UI patterns. Here are a few examples:

AMD Module Loader Support

If you're using an AMD loader like RequireJS, Waypoints registers itself as a named module, 'waypoints'. Shortcut scripts are anonymous modules.

License

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

Support

Unit tests for Waypoints are written with Jasmine and jasmine-jquery. You can run them here. If any of the tests fail, please open an issue and include the browser used, operating system, and description of the failed test.