-
Notifications
You must be signed in to change notification settings - Fork 0
Options
function
Default: undefined
The finished function is called after each AJAX call that loads new content, after the loading message is displayed. If the option is not overridden, or a falsy value is passed it, the default action will be to fade-out the loading message.
string
Default: "<em>Congratulations, you've reached the end of the internet.</em>"
The finishedMsg option is a string that can include HTML. This will be displayed when Infinite-Scroll encounters a HTTP status code indicating an error, or when no more elements are found by the itemSelector and the dataType is "html".
string
Default: "<em>Loading the next set of posts...</em>"
The msgText option is a string that can include HTML. This will be displayed next to img when new content is loading.
boolean
Default: false
Displays debugging information related to the operations of the plugin.
string
Default: "div.navigation a:first"
The nextSelector is used to pull the URL that is used to form all subsequent URLs that Infinite-Scroll uses to load more content. By default, Infinite-Scroll will attempt to parse out the URL pulled from the found element's href attribute. This URL can be decomposed by the user-supplied pathParse option. The URL will be ignored when the path option is used.
integer
Default: 150
The extraScrollPx option is used only when the animate option is set to true. It determines how far infinite-scroll will try to scroll down the page when next posts are appended to the DOM.
string
Default: "div.post"
The itemSelector is used to find the HTML elements that are inserted into the page when the dataType option is set to "html".
boolean
Default: true
Determines whether or not to animate scrolling after new elements have been appended to the DOM.
object (array) or function
Default: undefined
The pathParse option is used to help Infinite-Scroll determine the structure of the URL found by the nextSelector so that AJAX requests for more content are directed to the proper location.
By default, Infinite-Scroll will run through attempts to guess at the structure of your URL and break it down into component parts, however this is not always possible given the vast amounts of different URL configurations that are possible for pagination.
If you are confident that your URL structure will not change, it is possible to pass in an array of strings that will be concatenated with a call to .join(currentPage) to create a new URL. As an example, with a URL structure like /path/to/resource/html?page=2&foo=bar, you would write [/path/to/resource/html?page=", "&foo=bar"]. When a new URL is generated, the current page number will be inserted in between each element of the array.
Now in some cases, you may have a more dynamic structure that needs to be parsed, and a function is the proper way to do this. Let's say you have some additional GET parameters and a she-bang in your URL like /path/to/resource?page=2&foo=bar&dynamic=CA735B#!random-hashbang. You don't know what it might say, but you know it might be there. In that case, you're going to need to break down the URL dynamically to account for these situations:
pathParse: function (path, currentPage) {
// Parse out the URL into chunks here
// `chunkedUrl` should be `["/path/to/resource?page=", "&foo=bar&dynamic=CA735B#!random-hashbang"]`
return chunkedUrl;
}
string
Default: "html"
Determines the expected return type of any AJAX calls made by the plugin. Possible values include "html" and "json". The "json" option should be used in conjunction by setting the appendCallback to false and using the append callback to generate your page structure from the returned JSON.
function
Default: function() { }
Function that is called at the end of Infinite-Scroll's execution. Takes in a string with the value "done" as an argument. This appears to be a vestigial option with no real use and may be removed in the future. It's use is not recommended.
object (array) or function
Default: undefined
When set to either a string or a function, this will override Infinite Scroll's default attempt to guess the format of the URL pulled from the href of the element found by the nextSelector.
When an array is supplied, it should be broken down in a manner such that it will return a string representative of the URL to the next page when .join(currentPageNumber) is called on it.
["/path/to/resource/page/", "/html"]
If a function is passed in to path, the function will take one argument, currentPageNumber, which is a number. The function should return a URL as a string that will be used to fetch the next page.
function generatePageUrl(currentPageNumber) { return ("/path/to/resource/page/" + currentPageNumber + "/html"); }
boolean
Default: false
When set to true, Infinite Scroll will continue to load more pages until the window is full enough to trigger the vertical scrollbar. If the window is resized to be large enough to hide the vertical scrollbar, Infinite Scroll will load more content until the window is full again.
number
Default: undefined
This option is used to limit the number of pages that will be loaded by Infinite Scroll. Pages will continue loading until the page, as indicated by the current page state variable, exceeds the value of maxPage.