@webcreate/infinite-ajax-scroll

Turn your existing pagination into infinite scrolling pages with ease

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@webcreate/infinite-ajax-scroll
883113.0.17 months ago5 years agoMinified + gzip package size for @webcreate/infinite-ajax-scroll in KB

Readme

<img alt="Infinite Ajax Scroll" title="Infinite Ajax Scroll" src="https://infiniteajaxscroll.com/img/infinite-ajax-scroll-mark.svg" width="200">


Infinite Ajax Scroll

Turn your existing pagination into infinite scrolling pages with ease.
  • SEO friendly 🥇
  • Doesn't break browsers back button 💯
  • Highly customizable ✨

More features, documentation and examples available at: https://docs.infiniteajaxscroll.com/
npm

Installation

Use Infinite Ajax Scroll via CDN

Get up and running in no time by linking directly to Infinite Ajax Scroll on unpkg.
<script src="https://unpkg.com/@webcreate/infinite-ajax-scroll@^3/dist/infinite-ajax-scroll.min.js"></script>

Place this code right before the </body> tag on each template or page that you want to use infinite scroll on.

Manage as a package

Are you using NPM in your projects? You can install and update our package easily.
$ npm install --save @webcreate/infinite-ajax-scroll

Usage

Infinite Ajax Scroll works on a container with item elements which get appended. A next link is used to determine the next url.
<div class="container">
    <div class="item">...</div>
    <div class="item">...</div>
    <div class="item">...</div>
    ...
</div>

<div class="pagination">
    <a href="page2.html" class="next">Next</a>
</div>

Now you can configure Infinite Ajax Scroll:
// import if you use the NPM package
import InfiniteAjaxScroll from '@webcreate/infinite-ajax-scroll';

let ias = new InfiniteAjaxScroll('.container', {
  item: '.item',
  next: '.next',
  pagination: '.pagination'
});

Full documentation can be found at https://docs.infiniteajaxscroll.com

Licensing

Infinite Ajax Scroll is dual licensed:
  1. Under the Free Software Foundation’s GNU AGPL v.3.0; or
  2. Under an Infinite Ajax Scroll Commercial License

Buying a commercial license is mandatory as soon as you develop commercial activities distributing the Infinite Ajax Scroll software inside your product or deploying it on a network without disclosing the source code of your own applications under the AGPL license.
See https://infiniteajaxscroll.com/licenses/ for more details.