https://github.com/imakewebthings/waypoints

Waypoints is a library that makes it easy to execute a function whenever you scroll to an element.
https://github.com/imakewebthings/waypoints

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/imakewebthings/waypoints
• Owner: imakewebthings
• Created: 2011-01-25T07:46:22.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2022-11-18T05:01:47.000Z (almost 2 years ago)
• Last Synced: 2024-05-17T16:41:31.993Z (6 months ago)
• Language: JavaScript
• Homepage: http://imakewebthings.com/waypoints/
• Size: 1.29 MB
• Stars: 10,369
• Watchers: 286
• Forks: 1,340
• Open Issues: 102
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: licenses.txt

Awesome Lists containing this project

• awesome-github-repos - imakewebthings/waypoints - Waypoints is a library that makes it easy to execute a function whenever you scroll to an element. (JavaScript)
• awesome-github-star - waypoints
• awesome-list - Waypoints - A library that makes it easy to execute a function whenever you scroll to an element. (Web Development / C++/C Toolkit)

README

        
# Waypoints

Waypoints is a library that makes it easy to execute a function whenever you scroll to an element. ![Build Status](https://travis-ci.org/imakewebthings/waypoints.svg)

```js

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](http://imakewebthings.com/waypoints/guides/getting-started) guide.

[Read the full documentation](http://imakewebthings.com/waypoints/api/waypoint) 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:

- [Infinite Scrolling](http://imakewebthings.com/waypoints/shortcuts/infinite-scroll)

- [Sticky Elements](http://imakewebthings.com/waypoints/shortcuts/sticky-elements)

- [Inview Detection](http://imakewebthings.com/waypoints/shortcuts/inview)

## Contributing

If you want to report a Waypoints bug or contribute code to the library, please read the [Contributing Guidelines](https://github.com/imakewebthings/waypoints/blob/master/CONTRIBUTING.md). If you need help *using* Waypoints, please do not open an issue. Instead, ask the question on [Stack Overflow](http://stackoverflow.com) and tag it with #jquery-waypoints. Be sure to follow the guidelines for [asking a good question](http://stackoverflow.com/help/how-to-ask).

## License

Copyright (c) 2011-2014 Caleb Troughton. Licensed under the [MIT license](https://github.com/imakewebthings/waypoints/blob/master/licenses.txt).