PageMe

Copyright 2013 by Atec Media and Jens Eldering.

PageMe by Jens Eldering is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Based on a work at https://github.com/Scribilicious/jquery.pageme.

Summary

PageMe is a jQuery auto paging plug-in. Just scroll to the bottom to load the next page.

Getting started

Check the demo in this package.

Creating an basic instance is done as followed:

$(document).ready(function() {
    $(".content").pageme();
});

Options

PageMe can be customised by passing a set of options. The following example is the pageme instance with all the options and default settings:

$(".content").pageme({
    status     : '<div class="scrollLoad"></div>',
    loading    : 'Loading...',
    finished   : 'Finished...',
    error      : 'Error loading...',
    statusfade : 500,
    statuspause: 1000,
    container  : '.container',
    next       : '.next',
    navigation : '.navigate',
    nextfade   : 500,
    type       : 'html'
});

status

Status contains the status container. This is the container that is being viewed while loading. This should contain only one element! If false or empty, all statuses will be ignored

loading, finished, error

These options contain the several statuses that pageme can contain. If needed HTML can be passed through these options. For example an animated loading image. If false no status is shown.

statusfade

The fading speed of the status message. If false no fading will occur.

statuspause

The waiting time between fading. This will only have effect on the error and finished status.

container

The container element that contains the actual content of the page without the navigation elements. So just the data that needs to be auto paginated.

next

The next page element. This element must be of the the type <a> and needs to contain a href link.

navigation

This is the navigation element that contains all the navigation elements.

nextfade

The fading speed of when viewing the next page. If set to false no fading will occur!

type

The content type of the to be loaded page. Normally this is HTML.

Known issues

When used from a file:// URL some access control errors can occur. Solution, run script instead in a local or online server environment.