Lightbox2

stella - March 22, 2006 - 02:03

The Lightbox2 module is a simple, unobtrusive script used to overlay images on the current page. It's a snap to setup and works on most modern browsers.

The module places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths. It keeps users on the same page. Clicking to view an image and then having to click the back button to return to your site is bad for continuity (and no fun!).

Features

The version 2 module has several benefits over the plain Lightbox module. Note, not all of these features are available in the 4.7.x version or when the "Lightbox2 Lite" option is enabled.

  • Image Sets: group related images and navigate through them with ease - ideal for your image galleries.
  • Slideshow Capability: automatically transition between grouped images, includes play/pause and previous and next buttons.
  • HTML Content Support: ability to show websites or other HTML content in a lightbox.
  • Video Content Support: ability to show videos in a lightbox.
  • Visual Effects: fancy pre-loader and transition when you click on the image.
  • Keyboard Shortcuts: useful keyboard shortcuts for switching between images, toggling play / pause, etc.
  • Drupal Login Support: ability for the Drupal login form to appear in a lightbox.
  • Zoom Capability: larger images are reduced in size so they fit snugly inside the browser window. A zoom in button can then be clicked on to see it in its original size, while a zoom out button is provided to return you to the scaled down version.
  • Choice of Layouts: there are two layouts provided, not including the "Lightbox2 Lite" version.
  • Automatic Image Detection: configurable automatic re-formatting of image node thumbnails, previews, etc, so there is no need to add 'rel="lightbox"' to each image node link on your site. Image, Inline, Flickr, Acidfree Albums, Image Assist, Embedded Media Field and CCK Imagefield modules are all supported (images must have the "inline", "thumbnail", "image-thumbnail", "preview", "image-preview", etc, classes). It's also possible to configure a list of custom image classes which will trigger the lightbox when clicked on.
  • Control Over Lightbox Image Size: configure which image size should be displayed in the lightbox, e.g. preview or original.
  • Imagecache Support: adds a Lightbox2 field formatter for CCK imagefields for your custom views.
  • Image Page Link: a link to the image page can be provided within the lightbox itself. You can even specify if it should be opened in the current window or a new window.
  • Page Exclusion Capability: exclude certain pages on your site from having the lightbox2 functionality.
  • Login Support: ability to modify all user/login links so the login form appears in a lightbox.
  • Skin and Animation Configuration: configure the order and speed of the lightbox animations, along with the lightbox colors, border size and overlay opacity.
  • Gallery 2 Support: support for Gallery 2 images via the Gallery module (beta). See #179261 for information on how to customise your Gallery2 theme to work with lightbox.
  • Right-to-Left Language Support: support for right-to-left languages and themes.

Dependencies

4.7.x, 5.x-1.0.x & 5.x-1.1
The Drupal 4.7 version of the lightbox2 module, along with 5.x-1.0.x & 5.x-1.1, use Scriptaculous and Prototype libraries. Due to variation in licensing, you will need to download these libraries separately. For 4.7.x, please download the latest versions of the libraries from http://script.aculo.us/download. For 5.x-1.0.x & 5.x-1.1, please visit: http://www.stellapowerdesign.net/scriptaculous-drupal.zip. See the README.txt file for more details. No new features will be added to these versions and support for these versions has now been dropped. It is recommended that you upgrade to version 5.x-2.0 or later.

5.x-2.0 & later, 6.x
Lightbox2 5.x-2.0 and later versions now all use the jQuery library instead of the Scriptaculous and Prototype libraries, so there is no need to download and install a separate third party package. The 5.x versions have a dependency on the jQuery update module since the version of jQuery included in Drupal core is not that recent. Both the 1.x and 2.x versions of this module should work with Lightbox2.

There is no such dependency for the 6.x versions.

Known Issues

Please read the known issues page before logging a support request for the module. Thanks!

Comparison with Similar Modules

Please read the article at http://drupal.org/node/266126

Releases

Official releasesDateSizeLinksStatus
6.x-1.82008-Jun-2994 KBRecommended for 6.xThis is currently the recommended release for 6.x.
5.x-2.82008-Jun-2988.04 KBRecommended for 5.xThis is currently the recommended release for 5.x.
4.7.x-1.12007-May-0825.8 KBRecommended for 4.7.xThis is currently the recommended release for 4.7.x.
Development snapshotsDateSizeLinksStatus
6.x-1.x-dev2008-Sep-0595.3 KBDevelopment snapshotDevelopment snapshots are automatically regenerated and their contents can frequently change, so they are not recommended for production use.
5.x-2.x-dev2008-Sep-0788.51 KBDevelopment snapshotDevelopment snapshots are automatically regenerated and their contents can frequently change, so they are not recommended for production use.
4.7.x-1.x-dev2007-Jun-2926.01 KBDevelopment snapshotDevelopment snapshots are automatically regenerated and their contents can frequently change, so they are not recommended for production use.
 
 

Drupal is a registered trademark of Dries Buytaert.