Pager API - v0.4
Constructor
fluid.Pager(componentContainerId, options);
Parameters
componentContainerId
The componentContainerId parameter is the ID of the root DOM node of the Pager markup.
options
The options parameter is an optional collection of name-value pairs that configure the Pager:
Name | Description | Values | Default |
|---|---|---|---|
| Javascript object containing selectors for various fragments of the Pager component. | The object may contain any subset of the following keys: |
selectors: {
pagerTop: ".pager-top",
pagerBottom: ".pager-bottom",
pageLinks: ".page-link",
previous: ".previous",
next: ".next"
}
|
| Javascript object containing CSS style names that will be applied to the Pager component. | The object may contain any subset of the following keys: |
styles: {
currentPage: "current-page",
disabled: "disabled"
}
|
| A function that will be called each time a new page has been selected. This function will most likely retrieve data for the selected page, or otherwise update the data. | a function |
pageWillChange: function (link) {
}
|
Functions
fluid.Pager.next();
Selects the next page in the list of pages. If the current page is the last one, no action is taken.
fluid.Pager.previous();
Selects the previous page in the list of pages. If the current page is the first one, no action is taken.
fluid.Pager.selectPage(pageNum);
Selects a particular page in the list of pages. If the given page number (pageNum) is invalid, or is the same as the current page, no action is taken.
Dependencies
The Pager dependencies can be met by including the minified Fluid-all.js file in the header of the HTML file:
<script type="text/javascript" src="Fluid-all.js"></script>
Alternatively, the individual file requirements are:
<script type="text/javascript" src="jquery/jquery-1.2.6.js"></script>
<script type="text/javascript" src="fluid/Fluid.js"></script>
<script type="text/javascript" src="fluid/Pager.js"></script>