Package Exports

super-pagination

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (super-pagination) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Super Pagination

Super Pagination for Node.js, Mongoose and Twitter Bootstrap. There two objects built into this module, one for paginating mongoose and one for creating pagination. When using the mongoose paginate function you are returned with results and the pagination object.

Installation

npm install super-pagination

API

Mongoose

paginate( ) `[type = 'function']`

Extend the mongoose model to run a pagination query.

@params :

type: Object

defaults: {
    per_page : 10,
    page : 1,
    url : '/',
    query : {},
    select : null,
    populate : null,
    sort : null
}

@callback :

type: `Function`

function(err, results, pagination){
    ...
}

mongoose.paginate([params], [callback]);

Usage

var mongoose = require('super-pagination').mongoose,
    Model = mongoose.model('Model');

Model.paginate({
    query : {
    },
    page : req.query.page || 1,
    select : 'name summary created',
    populate : 'user',
    sort : {
        'created' : -1
    },
    url : '/'
}, function(err, results, pagination){
    if (err) return console.log('Error', err);

    res.render(config.public_theme + '/list', {
        results : results,
        links : pagination.render()
    });
});

Paginator

set( ) `[type = 'function']`

Set the configuration for the pagination

@params:

type: Object

defaults: {
    total : 1000,
    per_page : 10,
    current_page : 2,
    url : '/',
    params : {

    },
    page_param : 'page',
    show_next : true,
    show_prev : true,
    next_text : '&raquo;',
    prev_text : '&laquo;',
    size : null,
    number_of_pages : 1,
    number_of_links : 5,
    show_empty : true
}

paginator.set([params]);

Usage

var paginator = require('super-pagination').paginator;

var pagination = new paginator().set({
    per_page : 10,
    current_page : 1,
    total : 1000,
    number_pages : Math.ceil(1000 / 10),
    url : '/'
});

render( ) `[type = 'function']`

Returns HTML in bootstrap format

paginator.render();

Usage

var html = pagination.render();

json( ) `[type = 'function']`

Returns JSON for building custom pagination.

paginator.json();

Usage

var json = pagination.json();