JQSerialPagerContrib

Splits up a list and makes it a pager scroller thingy

This is a jQuery plugin for Foswiki that implements a widget to handle long lists. It therefore splits the list and adds a pager so that it takes less screen estate overall to display all list elements. This kind of list pager comes in handy when displaying lots of navigation elements in a sidebar navigation.

This is a screenshot displaying a facet navigation in SolrPlugin listing all media types available in the current hit set of a search.

Usage

By adding

%JQREQUIRE{"serialpager"}%

the serial pager widget is available for use on the current page. This will process lists wrapped into a DIV element using the jqSerialPager class.

<div class="jqSeriaPager" data-parameters="...">
   * list item 
   * list item 
   * ...
</div>

This will process all list items inside according to the given parameters.

Name	Description	Default
pagesize	number of elements per page; if there are less elements in the list overall, no pager will be displayed	10
width	width of the widget	auto
easing	animation when flipping pages	easeOutQuart
duration	speed of animation effect flipping pages	500
cycle	boolean flag whether to jump to the first page when proceeding after the last one	true
counter	boolean flag whether to display the page indicator at the bottom, e.g. 1/7 means: page one of seven	true

Examples

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. "Extensions Operation and Maintenance" Tab -> "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button. Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not show up in the search results.

You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!)

cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> install

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See https://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Note you need to run configure & save at least once. This will automatically register the serial pager widget to Foswiki.

Dependencies

Name	Version	Description
Foswiki::Plugins::JQueryPlugin	>=4.20	Requires

Change History

26 Oct 2020:	compatibility with latest JQueryPlugin; fixed width based on width of parent container
30 Aug 2017:	fixed filter, keeping hidden items when a filter is changing again
23 Jan 2017:	fixed counting items in a list
01 Nov 2016:	added filter feature to search in large lists
02 Sep 2016:	fixed calculation of width of lists items in pager
11 Jul 2012:	initial release