Lightbox Application

Last modified by Thomas Mortagne on 2023/10/16 00:15

cogAllows to overlay images on the current page
Developed by

Oana Florea

Active Installs27
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


It's a snap to setup and works on all modern browsers.

This application is obsolete. It's easier to use the Lightbox Macro.


Once you have installed the application, add the following line into your wiki editor:

{{include document="XWiki.Lightbox"/}}

This will allow you to use the CSS and JavaScript code for the Lightbox as a skin extension.


Single Images

Add a rel="lightbox" attribute to any link tag to activate the Lightbox. For example:

<a href="$doc.getAttachmentURL('xeblog.jpg')" rel="lightbox" title="test caption"><img src="$doc.getAttachmentURL('xeblog.jpg')" width="250" height = "200"/></a>

When clicking on your image you will get a similar Lightbox:


Image Set

If you have a set of related images that you would like to group, follow step one but additionally include a group name between square brackets in the rel attribute. For example:

<a href="$doc.getAttachmentURL('installstep.jpg')" rel="lightbox[my-gallery]" title="test caption"><img src="$doc.getAttachmentURL('installstep2.jpg')" width="125" height = "100"/></a>
<a href="$doc.getAttachmentURL('xeblog.jpg')" rel="lightbox[my-gallery]" title="test caption"><img src="$doc.getAttachmentURL('xeblog.jpg')" width="125" height = "100"/></a>

When clicking on your image you will get a similar Lightbox that allows you to navigate between the group images:


Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Visit XWiki.LightboxTest to verify that the application is correctly installed.

Release Notes


This application is obsolete. It's easier to use the Lightbox Macro.

version 1.1 

  • Update to syntax 2.0. 
  • Tested with XWiki Enterprise 2.0.3

Get Connected