wiki.in.tum.de
Technische Universität München

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.

serial pager screenshot

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.

NameSorted ascending Description Default
counter boolean flag whether to display the page indicator at the bottom, e.g. 1/7 means: page one of seven true
cycle boolean flag whether to jump to the first page when proceeding after the last one true
duration speed of animation effect flipping pages 500
easing animation when flipping pages easeOutQuart
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

Examples

  • item 1
  • item 2
  • item 3
  • item 4
  • item 5
  • item 6
  • item 7
  • item 8
  • item 9
  • item 10
  • item 11
  • item 12
  • item 13
  • item 14
  • item 15
  • item 16
  • item 17
  • item 18
  • item 19
  • item 20

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.

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

Dependencies

NameVersionDescription
Foswiki::Plugins::JQueryPlugin>=4.20Requires

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

PackageForm edit

Author Michael Daum
Version 3.00
Release 26 Oct 2020
Description Splits up a list and makes it a pager scroller thingy
Repository https://github.com/foswiki/JQSerialPagerContrib
Copyright © 2012-2020 Michael Daum
License GPL (Gnu General Public License)
Home Foswiki:Extensions/JQSerialPagerContrib
Support Foswiki:Support/JQSerialPagerContrib
Topic revision: r1 - 23 Jan 2017, ProjectContributor
This site is powered by FoswikiCopyright &© by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback