dominate-filter-pages v3.0.2

Dominate-Filter-Pages

Browser pagination for Dominate.

Dominate-Filter-Pages filters DOM elements into separate pages of content. Which page is currently displayed can be controlled via the click event of certain DOM elements, or programmatically. This module is designed to filter content provided by the Dominate-Io-Dom module within the Dominate filtering framework.

API

Filter Options

• $next - A jQuery object containing the "next page" button. The next page is displayed when a click event is fired from this jQuery object. While viewing the last page, the class "disabled" is added to the element in this object.

• $prev - A jQuery object containing the "previous page" button. The previous page is displayed when a click event is fired from this jQuery object. While viewing the first page, the class "disabled" is added to the element in this jQuery object.

• perPage - An integer representing the maximum number of items to display per page.

• indexes - An object containing index button related options.

  • $container - A jQuery object containing a single div which will contain clickable index buttons for skipping to a particular page. Each button's ID is the page number it links to (starting index is 1).

  • classes - An array of class names to add to the index buttons.

  • currentClass - A class name to add to the index button representing the current page.

  • otherClass - A class name to add to the index buttons not representing the current page.

  • count - An integer representing the maximum number of index buttons to be displayed.

Info Object

• api
  • next - A function which displays the next page of content.
  • prev - A function which displays the previous page of content.