JQPhotoSwipeContrib

Modern javascript image gallery

Description

JQPhotoSwipeContrib is a thin wrapper to bring PhotoSwipe to Foswiki. It adds the minimum amount of glue to render an image gallery using this frontend. JQPhotoSwipeContrib is meant to be used together with ImagePlugin or ImageGalleryPlugin to render thumbnails on the backend while PhotoSwipe is used on the frontend.

The easiest way is to wrap a couple of %IMAGE tags with a div element using the jqPhotoSwipe css class.

%JQREQUIRE{"photoswipe"}%

<div class="jqPhotoSwipe">
%IMAGE{"image1.png" size="200"}%
%IMAGE{"image2.png" size="200"}%
%IMAGE{"image3.png" size="200"}%
%IMAGE{"image4.png" size="200"}%
</div>

As with other JQ...Contrib extensions the macro %JQREQUIRE{"photoswipe"}% will load the required javascript assets into the page including an initializer to process any thumbnails wrapped by a jqPhotoSwipe element.

Note that ImageGalleryPlugin detects JQPhotoSwipeContrib being installed automatically and will then switch to this frontend (starting with version 7.10).

Examples

You type:

%IMAGEGALLERY%

You get (if installed):

You type:

%JQREQUIRE{"photoswipe"}%
<div class="jqPhotoSwipe">
%IMAGE{"15008867125_b61960af01_h.jpg" size="95x95" crop="on"}%
%IMAGE{"15008518202_c265dfa55f_h.jpg" size="95x95" crop="on"}%
%IMAGE{"15008465772_d50c8f0531_h.jpg" size="95x95" crop="on"}%
%IMAGE{"14985871946_24f47d4b53_h.jpg" size="95x95" crop="on"}%
%IMAGE{"14985868676_b51baa4071_h.jpg" size="95x95" crop="on"}%
</div>

You get (if installed):

Options

Additional parameter to photoswipe might be specified using HTML5 data attributesm, such as in below example:

<div class="jqPhotoSwipe" data-allow-pan-to-next="false">
...
</div>

See the full documentation of all options.

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.

Dependencies

Name	Version	Description
Foswiki::Plugins::ImageGalleryPlugin	>=7.10	Optional
Foswiki::Plugins::ImagePlugin	>=7.20	Optional

Change History

22 Jan 2024	removed share button
04 May 2022	updated to PhotoSwipe 4.1.3; don't load pswp templates unconditionally, load it via js as required instead
18 Nov 2019	allow "swiping" of a single element
05 Mar 2018	updated to latest photoswipe version
24 Oct 2017	cleaned up photoswipe template from unnecessary html comments
02 Sep 2016	fixed Config.spec typo; fixed javascript initializer; better usability navigating images in gallery
30 May 2016	initial release