What is this?
Waypoints is a JavaScript library that makes it easy to run a function whenever the user scrolls to an element — the basic trigger for scroll-driven behavior on a page.
Waypoints is a JavaScript library that makes it easy to run a function whenever the user scrolls to an element — the basic trigger for scroll-driven behavior on a page.Is this a frontend library for web pages, or something else?It's a frontend library that runs in the browser: you attach waypoints to page elements and it fires callbacks as the user scrolls to them. Not a framework — just a script plus optional shortcut extensions.
It's a frontend library that runs in the browser: you attach waypoints to page elements and it fires callbacks as the user scrolls to them. Not a framework — just a script plus optional shortcut extensions.How do I get started with it?Follow the Getting Started guide linked at the top of the README, then use the full documentation for details on usage and customization.
Follow the Getting Started guide linked at the top of the README, then use the full documentation for details on usage and customization.Do I need jQuery or any other libraries to use it?The library declares no runtime dependencies of its own. Its Stack Overflow support tag is #jquery-waypoints, a leftover from its jQuery-plugin origins, so older tutorials may assume jQuery.
The library declares no runtime dependencies of its own. Its Stack Overflow support tag is #jquery-waypoints, a leftover from its jQuery-plugin origins, so older tutorials may assume jQuery.Does it build anything for me, or just tell me when to act?The core only fires your function at the scroll moment — what happens next (loading more content, toggling a sticky header) is your code. Shortcut extensions prepackage the most common patterns.
The core only fires your function at the scroll moment — what happens next (loading more content, toggling a sticky header) is your code. Shortcut extensions prepackage the most common patterns.Is it free to use, including in commercial projects?Yes — it's MIT-licensed, so personal and commercial use are both fine.
Yes — it's MIT-licensed, so personal and commercial use are both fine.Does it cover common patterns like infinite scroll or sticky headers out of the box?Yes — shortcut extensions ship for exactly those: Infinite Scrolling, Sticky Elements, and Inview Detection, layered on top of the core waypoint script.
Yes — shortcut extensions ship for exactly those: Infinite Scrolling, Sticky Elements, and Inview Detection, layered on top of the core waypoint script.What are similar projects?lax.js, Sortable, velocity, typeahead.js, iscroll, GSAP, scrollreveal, hammer.js
lax.js, Sortable, velocity, typeahead.js, iscroll, GSAP, scrollreveal, hammer.jsWhich topics is it in?scroll, dom, javascript-library, browser, ui, web-development, free, frontend, library, javascript, web, mit
scroll, dom, javascript-library, browser, ui, web-development, free, frontend, library, javascript, web, mit