jScroll is a jQuery plugin for infinite scrolling

Oct 30, 2014 in Scroll 15882 views

Download

Overview
Documents

User Rating: 4.1/5 ( 7 votes)

Your Rating:

jScroll is a jQuery plugin for infinite scrolling. Infinite scrolling; also known as lazy loading, endless scrolling, autopager, endless pages, etc.; is the ability to load content via AJAX within the current page or content area as you scroll down. The new content can be loaded automatically each time you scroll to the end of the existing content, or it can be triggered to load by clicking a navigation link at the end of the existing content.

An example of infinite scrolling is your Facebook "News Feed" page. You may notice that when you scroll to the bottom of this page, new content will often load automatically, or you will be given a link to "Older Posts" which will load more content when clicked.

Source: jscroll.com

1. INCLUDE CSS AND JS FILES

<link rel="stylesheet" type="text/css" href="/jscroll.css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="/jquery.jscroll.min.js"></script>

2. HTML

<div class="scroll">
    <h3>Page 1</h3>
    <p>Content here...</p>
    <a href="example-page2.html">next page</a>
</div>

3. JAVASCRIPT

$('.scroll').jscroll();

4. OPTIONS

The jscroll method takes an optional object literal as a parameter for overriding the default options. An example of how this can be done is shown below.

$('.infinite-scroll').jscroll({
    loadingHtml: '<img src="loading.gif" alt="Loading" /> Loading...',
    padding: 20,
    nextSelector: 'a.jscroll-next:last',
    contentSelector: 'li'
});

Options

Option Key	Default Value	Description
debug	false	When set to true, outputs useful information to the console display if the console object exists.
autoTrigger	true	When set to true, triggers the loading of the next set of content automatically when the user scrolls to the bottom of the containing element. When set to false, the required next link will trigger the loading of the next set of content when clicked.
autoTriggerUntil	false	Set to an integer great than 0 to turn offautoTrigger of paging after the specified number of pages. Requires autoTrigger to be true.
loadingHtml	'<small>Loading...</small>'	The HTML to show at the bottom of the content while loading the next set.
padding	0	The distance from the bottom of the scrollable content at which to trigger the loading of the next set of content. This only applies when autoTrigger is set to true.
nextSelector	'a:last'	The selector to use for finding the link which contains the href pointing to the next set of content. If this selector is not found, or if it does not contain a href attribute, jScroll will self-destroy and unbind from the element upon which it was called.
contentSelector	''	A convenience selector for loading only part of the content in the response for the next set of content. This selector will be ignored if left blank and will apply the entire response to the DOM.
callback	false	Pass a function to this option and it will be called at the end of each page load. Alternatively, you can pass a function as the only argument to the jScroll instantiation instead of an options object, and it will be returned as a callback.

JS Tutorial

jScroll is a jQuery plugin for infinite scrolling

Related Articles