Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.42 KB

README.md

File metadata and controls

78 lines (55 loc) · 2.42 KB
Raw

Yofinity Build Status

an infinite scroll jQuery plugin
npm version GitHub version

Demo page

Package manager

//bower
bower install --save yohoho.yofinity
//npm
npm install yohoho.yofinity

Install

<!-- In your <body> HTML tag -->

<a href="http://example.com/page/2" title="Next posts" rel="next">Loading...</a>
//in your main JS file
$('body').yofinity({
    buffer: 1000,
    navSelector: 'a[rel="next"]',
    success: function ($link, response){
        $link.before(response);
        $link.attr('href', '/page/2');
    },
    error: function ($link){
        $link.remove();
    }
});

Settings

Option Type Default Description
ajaxUrl string '' Ajax custom URL to specify if no next button is available (Usefull for WordPress sites with ajax call functions)
buffer integer 1000 Number of pixels to fire infinite scroll BEFORE the node element
context object window -
debug boolean false Enables the debug tools when it's needed
error function null Function called if script fires an error
iterator integer 1 Iterator may be used for pagination, define where to start. After each success call, the iterator is autoincremented
loading function null Function called when script fires loading
navSelector string 'a[rel="next"]' Define node element containing AJAX request through the href attribute
params object {} Parameters to send in POST or GET method
success function null Function called when script fires success
type string 'get' Method to send data with

Dependencies

jQuery latest version

Authors and Copyright

Made with ♥ by Achraf Chouk

Please, read LICENSE for more details.