waypoints README

The project's README from github.com/imakewebthings/waypoints. As one markdown file: 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.

waypoints (imakewebthings/waypoints)

Searching Database…

10.3K ·GitHub
Что это такое?Waypoints — это JavaScript-библиотека, которая упрощает запуск функции, когда пользователь прокручивает страницу до нужного элемента. Это базовый триггер для поведения, привязанного к прокрутке.
Это фронтенд-библиотека для веб-страниц или что-то другое?Это фронтенд-библиотека, которая работает в браузере: вы привязываете waypoints к элементам страницы, и она вызывает колбэки, когда пользователь прокручивает до них. Это не фреймворк — просто скрипт плюс необязательные расширения-шорткаты.
С чего мне начать?Следуйте руководству Getting Started, ссылка на которое есть в начале README, а затем обращайтесь к полной документации за подробностями по использованию и настройке.
Мне нужен jQuery или какие-то другие библиотеки для работы с ней?У библиотеки нет собственных зависимостей во время работы. Её тег поддержки на Stack Overflow — #jquery-waypoints, это наследие origins в виде jQuery-плагина, поэтому в старых туториалах может предполагаться jQuery.
Она что-то делает за меня или просто сообщает, когда действовать?Ядро лишь вызывает вашу функцию в момент прокрутки — что делать дальше (подгружать больше контента, включать липкую шапку), решает ваш код. Расширения-шорткаты готовы дают самые распространённые шаблоны.
Можно ли пользоваться бесплатно, в том числе в коммерческих проектах?Да — она распространяется по лицензии MIT, так что личное и коммерческое использование разрешены.
Есть ли из коробки распространённые шаблоны вроде бесконечной прокрутки или липкой шапки?Да — для этого как раз есть расширения-шорткаты: Infinite Scrolling, Sticky Elements и Inview Detection, надстроенные поверх основного скрипта waypoint.
Size
1.3 MB
Stars
10.3K
Updated
CommitSep 03
Age
15y
Commits · 90 Days