This documentation refers to the latest trunk version of the Pager code.
Pager Overview
The Pager component allows users to break up long lists of items into separate pages.
Markup assumptions
Unlike many other Fluid Components, the Pager makes certain assumptions about the structure of the HTML markup it is applied to:
- The entire pager is contained within some kind of container element.
- Within that container, there are two 'pager bar' elements, each containing:
- an element containing page links
- a 'next' element
- a 'previous' element
The Pager uses CSS selectors to access these various components. Default selectors are assumed, which can be overriden (see #options below).
Join the fluid-talk mailing list and ask your questions there.
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 isthe same as the current page, no action is taken.