Pagination

Override defaults with $.fn.pagination.defaults.

Dependencies

Usage

  1. <div id="pp" style="background:#efefef;border:1px solid #ccc;"></div>  
  1. $('#pp').pagination({  
  2.     total:2000,  
  3.     pageSize:10  
  4. });  

Properties

Name Type Description Default
total number The total records, which should be setted when pagination is created. 1
pageSize number The page size. 10
pageNumber number Show the page number when pagination is created. 1
pageList array User can change the page size. The pageList property defines how many size can be changed. [10,20,30,50]
loading boolean Defines if data is loading. false
buttons array Defines custom buttons, each button contains two properties:
iconCls: the CSS class which will show a background image
handler: a handler function when button is clicked
null
showPageList boolean Defines if to show page list. true
showRefresh boolean Defines if to show refresh button. true
beforePageText string Show a label before the input component. Page
afterPageText string Show a label after the input component. of {pages}
displayMsg string Display a page information. Displaying {from} to {to} of {total} items

Events

Name Parameters Description
onSelectPage pageNumber, pageSize Fires when user select a new page. callback function contains two parameter:
pageNumber: the new page number
pageSize: the new page size
onBeforeRefresh pageNumber, pageSize Fires before the refresh button is clicked, return false to cancel the refresh action.
onRefresh pageNumber, pageSize Fires after refresh.
onChangePageSize pageSize Fires when user change the page size.

Methods

Name Parameter Description
options none Return the options object.
loading none Make the pagination to become loading status.
loaded none Make the pagination to become loaded status.