LICENSE
4 years ago
README.md
4 years ago
infinite-scroll.pkgd.js
4 years ago
infinite-scroll.pkgd.min.js
4 years ago
README.md
178 lines
| 1 | # Infinite Scroll |
| 2 | |
| 3 | _Automatically add next page_ |
| 4 | |
| 5 | See [](https://infinite-scroll.cominfinite-scroll.com](https://infinite-scroll.com](https://infinite-scroll.com) for complete docs and demos. |
| 6 | |
| 7 | ## Install |
| 8 | |
| 9 | ### Download |
| 10 | |
| 11 | - [](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.min.jsinfinite-scroll.pkgd.min.js](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.min.js](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.min.js) minified, or |
| 12 | - [](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.jsinfinite-scroll.pkgd.js](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.js](https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.js) un-minified |
| 13 | |
| 14 | ### CDN |
| 15 | |
| 16 | Link directly to Infinite Scroll files on [](https://unpkg.comunpkg](https://unpkg.com](https://unpkg.com). |
| 17 | |
| 18 | ``` html |
| 19 | <script src="https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.min.js"></script> |
| 20 | <!-- or --> |
| 21 | <script src="https://unpkg.com/infinite-scroll@4/dist/infinite-scroll.pkgd.js"></script> |
| 22 | ``` |
| 23 | |
| 24 | ### Package managers |
| 25 | |
| 26 | npm: `npm install infinite-scroll` |
| 27 | |
| 28 | Yarn: `yarn add infinite-scroll` |
| 29 | |
| 30 | ## License |
| 31 | |
| 32 | ### Commercial license |
| 33 | |
| 34 | 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 [](https://infinite-scroll.com/#commercial-licenseinfinite-scroll.com](https://infinite-scroll.com/#commercial-license](https://infinite-scroll.com/#commercial-license) |
| 35 | |
| 36 | ### Open source license |
| 37 | |
| 38 | If you are creating an open source application under a license compatible with the [](https://www.gnu.org/licenses/gpl-3.0.htmlGNU GPL license v3](https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html), you may use Infinite Scroll under the terms of the GPLv3. |
| 39 | |
| 40 | [](https://infinite-scroll.com/license.htmlRead more about Infinite Scroll's license](https://infinite-scroll.com/license.html](https://infinite-scroll.com/license.html). |
| 41 | |
| 42 | ## Usage |
| 43 | |
| 44 | Infinite Scroll works on a container element with its child item elements |
| 45 | |
| 46 | ``` html |
| 47 | <div class="container"> |
| 48 | <article class="post">...</article> |
| 49 | <article class="post">...</article> |
| 50 | <article class="post">...</article> |
| 51 | ... |
| 52 | </div> |
| 53 | ``` |
| 54 | |
| 55 | ### Options |
| 56 | |
| 57 | ``` js |
| 58 | let infScroll = new InfiniteScroll( '.container', { |
| 59 | // defaults listed |
| 60 | |
| 61 | path: undefined, |
| 62 | // REQUIRED. Determines the URL for the next page |
| 63 | // Set to selector string to use the href of the next page's link |
| 64 | // path: '.pagination__next' |
| 65 | // Or set with {{#}} in place of the page number in the url |
| 66 | // path: '/blog/page/{{#}}' |
| 67 | // or set with function |
| 68 | // path: function() { |
| 69 | // return return '/articles/P' + ( ( this.loadCount + 1 ) * 10 ); |
| 70 | // } |
| 71 | |
| 72 | append: undefined, |
| 73 | // REQUIRED for appending content |
| 74 | // Appends selected elements from loaded page to the container |
| 75 | |
| 76 | checkLastPage: true, |
| 77 | // Checks if page has path selector element |
| 78 | // Set to string if path is not set as selector string: |
| 79 | // checkLastPage: '.pagination__next' |
| 80 | |
| 81 | prefill: false, |
| 82 | // Loads and appends pages on intialization until scroll requirement is met. |
| 83 | |
| 84 | responseBody: 'text', |
| 85 | // Sets the method used on the response. |
| 86 | // Set to 'json' to load JSON. |
| 87 | |
| 88 | domParseResponse: true, |
| 89 | // enables parsing response body into a DOM |
| 90 | // disable to load flat text |
| 91 | |
| 92 | fetchOptions: undefined, |
| 93 | // sets custom settings for the fetch() request |
| 94 | // for setting headers, cors, or POST method |
| 95 | // can be set to an object, or a function that returns an object |
| 96 | |
| 97 | outlayer: false, |
| 98 | // Integrates Masonry, Isotope or Packery |
| 99 | // Appended items will be added to the layout |
| 100 | |
| 101 | scrollThreshold: 400, |
| 102 | // Sets the distance between the viewport to scroll area |
| 103 | // for scrollThreshold event to be triggered. |
| 104 | |
| 105 | elementScroll: false, |
| 106 | // Sets scroller to an element for overflow element scrolling |
| 107 | |
| 108 | loadOnScroll: true, |
| 109 | // Loads next page when scroll crosses over scrollThreshold |
| 110 | |
| 111 | history: 'replace', |
| 112 | // Changes the browser history and URL. |
| 113 | // Set to 'push' to use history.pushState() |
| 114 | // to create new history entries for each page change. |
| 115 | |
| 116 | historyTitle: true, |
| 117 | // Updates the window title. Requires history enabled. |
| 118 | |
| 119 | hideNav: undefined, |
| 120 | // Hides navigation element |
| 121 | |
| 122 | status: undefined, |
| 123 | // Displays status elements indicating state of page loading: |
| 124 | // .infinite-scroll-request, .infinite-scroll-load, .infinite-scroll-error |
| 125 | // status: '.page-load-status' |
| 126 | |
| 127 | button: undefined, |
| 128 | // Enables a button to load pages on click |
| 129 | // button: '.load-next-button' |
| 130 | |
| 131 | onInit: undefined, |
| 132 | // called on initialization |
| 133 | // useful for binding events on init |
| 134 | // onInit: function() { |
| 135 | // this.on( 'append', function() {...}) |
| 136 | // } |
| 137 | |
| 138 | debug: false, |
| 139 | // Logs events and state changes to the console. |
| 140 | }) |
| 141 | ``` |
| 142 | |
| 143 | ## Browser support |
| 144 | |
| 145 | Infinite Scroll v4 supports Chrome 60+, Edge 79+, Firefox 55+, Safari 11+. |
| 146 | |
| 147 | For IE10 and Android 4 support, try [](https://v3.infinite-scroll.com/Infinite Scroll v3](https://v3.infinite-scroll.com/](https://v3.infinite-scroll.com/). |
| 148 | |
| 149 | ## Development |
| 150 | |
| 151 | This package is developed with Node.js v14 and npm v6. Manage Node and npm version with [](https://github.com/nvm-sh/nvmnvm](https://github.com/nvm-sh/nvm](https://github.com/nvm-sh/nvm). |
| 152 | |
| 153 | ``` sh |
| 154 | nvm use |
| 155 | ``` |
| 156 | |
| 157 | Install dependencies |
| 158 | |
| 159 | ``` sh |
| 160 | npm install |
| 161 | ``` |
| 162 | |
| 163 | Lint |
| 164 | |
| 165 | ``` sh |
| 166 | npm run lint |
| 167 | ``` |
| 168 | |
| 169 | Run tests |
| 170 | |
| 171 | ``` sh |
| 172 | npm test |
| 173 | ``` |
| 174 | |
| 175 | --- |
| 176 | |
| 177 | By [](https://metafizzy.coMetafizzy 🌈🐻](https://metafizzy.co](https://metafizzy.co) |
| 178 |