Summary

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

Waypoints makes a solid base for modern UI patterns that depend on a user’s scroll position on the page. Take a look at a few examples.

Configuration

The module has an admin interface, where you can enable to always include the JavaScript file to the site.
Otherwise you can include it manually via a simple function callback:

<?php
drupal_add_library('waypoints', 'waypoints');
?>

Usage

For example:

jQuery('#comments').waypoint(function() {
   alert('You have scrolled to the comments.');
});
(function ($) {
  $(document).ready(function() {
    if ($('#block-1').length) {
      var waypoint = new Waypoint({
        element: document.getElementById('block-1'),
        handler: function(direction) {
          $('.another-block')
            .toggleClass('someclass', direction === 'down');
        }
      });
    }
  });
}(jQuery));

For the full documentation visit the plugin's homepage.

Views Load More module supports the use of this module.

Project information

Releases