pagination

';
return html;
}
});
console.log(boostrapPaginator.render());
`

$3

`js
var pagination = require('pagination');
var paginator = new pagination.SearchPaginator({prelink:'/', current: 10, rowsPerPage: 200, totalResult: 10020});
console.log(paginator.render());
// output (without newlines)
`

`html



`

$3

`js
var pagination = require('pagination');
var paginator = new pagination.SearchPaginator({prelink:'/', current: 3, rowsPerPage: 200, totalResult: 10020});
console.log(paginator.getPaginationData());

// output
{ prelink: '/',
current: 3,
previous: 2,
next: 4,
first: 1,
last: 51,
range: [ 1, 2, 3, 4, 5 ],
fromResult: 401,
toResult: 600,
totalResult: 10020,
pageCount: 51 }
`


Pagination on client side


`html

`
You can browse example folder for more. Release folder contains all mimified versions for browser. To customize your need you can use ./bin/build.js -h
html += paginator.render();

Classes

$3

* options See Options bellow

See also http://developer.yahoo.com/ypatterns/navigation/pagination/search.html

$3

* options See Options bellow

See also http://developer.yahoo.com/ypatterns/navigation/pagination/item.html

$3

* options See Options bellow

This class will render the markup as desired. The options must contains property "template"
It can be either a template string or a compiled template. The local variables available in the template are

* prelink String
* preparedPreLink String
* current Integer
* previous Integer
* next Integer
* first Integer
* last Integer
* range Array
* fromResult Integer
* toResult Integer
* totalResult Integer
* pageCount Integer
* translations Object with properties NEXT, PREVIOUS, FIRST, LAST, CURRENT_PAGE_REPORT

API

$3

Return an object contains data for rendering markup. See example above.

$3

Set value to a single for option. See options section bellow

$3

* prelink String

Append page param to the link

$3

Return the rendered markup

$3

* type String
* options Object see Options section bellow

Wrapper for create instance of classes above

$3

See pagination.TemplateEngine.compile bellow

$3

* str Template string
* options object which can contains .open .close .cache and .id

Options

Object to pass to paginator classes (second argument when using create function)

$3

Number of total items in result set

$3

Link to append the page-param

$3

Number of items per page, default to 10

$3

Number of links to create in page range, default to 5. This value will be ignored when using item pagination.

$3

Indicate which page is the current one. Page always starts with 1.

$3

To indicate if the result from CURRENT_PAGE_REPORT translation can be cached or not. Default is false.
The cache is global and will be the same for all instances which have specified translationCacheKey as bellow.

$3

For supporting multiple versions of translation of CURRENT_PAGE_REPORT. It can use for multilanguages or different formats. Default is "en"

$3

For translations of FIRST, NEXT, ... Simple example
`js
var translations = {
'PREVIOUS' : 'Voorgaand',
'NEXT' : 'Volgende',
'FIRST' : 'Eerst',
'LAST' : 'Laatste',
'CURRENT_PAGE_REPORT' : 'Resulten {FromResult} - {ToResult} van {TotalResult}'
};

var item = new ItemPaginator({
prelink : '/',
pageLinks : 5,
current : 5,
totalResult : 100,
translator : function(str) {
return translations[str];
}
});
``

$3

The name of the page parameter. Default is "page"

$3

Indicate if using slash instead of equal sign, ie /page/2 instead of /?page=2, default is false.

$3

This can be a template string or a compiled template (function).
The compiled function will be called with an object as argument.

Acknowledgements

Template engine is taking mostly from https://github.com/vanng822/ejs which is a fork of https://github.com/visionmedia/ejs