Infinite Scroll

Automatically add next page

Scrolling
metafizzy/infinite-scrollinfinite-scroll.cominfinite-scroll

README

Infinite Scroll


_Automatically add next page_

See infinite-scroll.com for complete docs and demos.

Install


Download


- infinite-scroll.pkgd.min.js minified, or
- infinite-scroll.pkgd.js un-minified

CDN


Link directly to Infinite Scroll files on unpkg.

  1. ``` html
  2. <script src="https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.min.js"></script>
  3. <script src="https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.js"></script>
  4. ```

Package managers


npm: npm install infinite-scroll

Yarn: yarn add infinite-scroll

License


Commercial license


If you want to use Infinite Scroll to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase an Infinite Scroll Commercial License at infinite-scroll.com

Open source license


If you are creating an open source application under a license compatible with the GNU GPL license v3, you may use Infinite Scroll under the terms of the GPLv3.

Read more about Infinite Scroll's license.

Usage


Infinite Scroll works on a container element with its child item elements

  1. ``` html
  2. <div class="container">
  3.   <article class="post">...</article>
  4.   <article class="post">...</article>
  5.   <article class="post">...</article>
  6.   ...
  7. </div>
  8. ```

Options


  1. ``` js
  2. let infScroll = new InfiniteScroll( '.container', {
  3.   // defaults listed

  5.   path: undefined,
  6.   // REQUIRED. Determines the URL for the next page
  7.   // Set to selector string to use the href of the next page's link
  8.   // path: '.pagination__next'
  9.   // Or set with {{#}} in place of the page number in the url
  10.   // path: '/blog/page/{{#}}'
  11.   // or set with function
  12.   // path: function() {
  13.   //   return return '/articles/P' + ( ( this.loadCount + 1 ) * 10 );
  14.   // }

  16.   append: undefined,
  17.   // REQUIRED for appending content
  18.   // Appends selected elements from loaded page to the container

  20.   checkLastPage: true,
  21.   // Checks if page has path selector element
  22.   // Set to string if path is not set as selector string:
  23.   //   checkLastPage: '.pagination__next'

  25.   prefill: false,
  26.   // Loads and appends pages on intialization until scroll requirement is met.

  28.   responseBody: 'text',
  29.   // Sets the method used on the response.
  30.   // Set to 'json' to load JSON.

  32.   domParseResponse: true,
  33.   // enables parsing response body into a DOM
  34.   // disable to load flat text

  36.   fetchOptions: undefined,
  37.   // sets custom settings for the fetch() request
  38.   // for setting headers, cors, or POST method
  39.   // can be set to an object, or a function that returns an object

  41.   outlayer: false,
  42.   // Integrates Masonry, Isotope or Packery
  43.   // Appended items will be added to the layout

  45.   scrollThreshold: 400,
  46.   // Sets the distance between the viewport to scroll area
  47.   // for scrollThreshold event to be triggered.

  49.   elementScroll: false,
  50.   // Sets scroller to an element for overflow element scrolling

  52.   loadOnScroll: true,
  53.   // Loads next page when scroll crosses over scrollThreshold

  55.   history: 'replace',
  56.   // Changes the browser history and URL.
  57.   // Set to 'push' to use history.pushState()
  58.   //    to create new history entries for each page change.

  60.   historyTitle: true,
  61.   // Updates the window title. Requires history enabled.

  63.   hideNav: undefined,
  64.   // Hides navigation element

  66.   status: undefined,
  67.   // Displays status elements indicating state of page loading:
  68.   // .infinite-scroll-request, .infinite-scroll-load, .infinite-scroll-error
  69.   // status: '.page-load-status'

  71.   button: undefined,
  72.   // Enables a button to load pages on click
  73.   // button: '.load-next-button'

  75.   onInit: undefined,
  76.   // called on initialization
  77.   // useful for binding events on init
  78.   // onInit: function() {
  79.   //   this.on( 'append', function() {...})
  80.   // }

  82.   debug: false,
  83.   // Logs events and state changes to the console.
  84. })
  85. ```

Browser support


Infinite Scroll v4 supports Chrome 60+, Edge 79+, Firefox 55+, Safari 11+.

For IE10 and Android 4 support, try Infinite Scroll v3.

Development


This package is developed with Node.js v14 and npm v6. Manage Node and npm version with nvm.

  1. ``` sh
  2. nvm use
  3. ```

Install dependencies

  1. ``` sh
  2. npm install
  3. ```

Lint

  1. ``` sh
  2. npm run lint
  3. ```

Run tests

  1. ``` sh
  2. npm test
  3. ```


By Metafizzy 🌈🐻