If true the Paginator will be always visible, even when the number
of pages is 0. To hide the paginator controls automatically when
there is no pages to display use false
.
Default Value: true
The Paginator controls UI could be displayed in more than one
container (i.e., in the header and footer of a list). Pass a
NodeList or a selector to grab the
containers.
Default Value: null
The
Node or template to be used as the
first link element.
Default Value: Generated anchor element.
The
Node or template to be used as the
last link element.
Default Value: Generated anchor element.
The max number of page links to be displayed. If lower than the
total number of pages they are still navigable using next and prev
links.
Default Value: 10
The
Node or template to be used as the
next link element.
Default Value: Generated anchor element.
page
- Number
Page to display on initial paint.
Default Value: 1
HTML Template for the page links container.
Default Value: Generated span HTML element.
Function which set the content of the each page element. The passed
function receive as arguments the reference for the page element
node, the page number and the index of the page element.
Example:
function(pageEl, pageNumber, index) {
pageEl.html(pageNumber);
}
Default Value: Basic function to set the html of the page element with the page number.
HTML Template for the link elements.
Default Value: Generated anchor HTML element.
Node element to display the page report (i.e., (1 of 100)).
Default Value: Generated span HTML element.
Template for the
pageReportEl content.
Note the placeholders for the page {page} and the total pages
{totalPages}.
Default Value: '({page} of {totalPages})'
The
Node or template to be used as the
prev link element.
Default Value: Generated anchor element.
Number of records constituting a "page".
Default Value: 1
Default Value: Generated select HTML element.
Array to be displayed on the generated HTML Select element with the
rowsPerPage
information. (i.e., [1,3,5,7], will display these values on the
select)
Default Value: []
Generates information to the
changeRequest
event. See
changeRequest.
Default Value: {}
Template used to render controls. The string will be used as
innerHTML on all specified container nodes. Bracketed keys (e.g.
{pageLinks}) in the string will be replaced with an instance of the
so named ui component.
Default Value: '{FirstPageLink} {PrevPageLink} {PageLinks} {NextPageLink} {LastPageLink} {CurrentPageReport} {Total} {RowsPerPageSelect}'
Total number of records to paginate through.
Default Value: 0
Node element to display the total information.
Default Value: Generated span HTML element.
The label markup to the total information.
Default Value: '(Total {total})'