Colorbox

Colorbox is a lightweight customizable lightbox plugin for jQuery 1.3 and 1.4. This module allows for integration of Colorbox into Drupal.

Images, forms, iframed or inline content etc. can be displayed in a overlay above the current page.

Features

The Colorbox module:

• Excellent integration with Imagefield, Imagecache, Insert and Image modules
• Choose between a default style and a number of other styles that are included.
• Style the Colorbox with a custom Colorbox style in your theme.
• Option to open a login form by clicking on any login link
• Simple API to open a selection of forms in a Colorbox
• Drush command to download and install the Colorbox plugin in sites/all/libraries as well as a Drush make file

The Colorbox plugin:

• Supports images, image groups, slideshow, ajax, inline, and iframed content.
• Appearance is controlled through CSS so users can restyle the box.
• Preloads background images and can preload upcoming images in a photo group.
• Generates W3C valid XHTML and adds no JS global variables & passes JSLint.
• Tested in Firefox 2 & 3, Safari 3 & 4, Opera 9, Chrome, Internet Explorer 6, 7, 8.
• Released under the MIT License.

The plugin is downloaded separately from the Colorbox homepage.

Colorbox Screencasts

• Colorbox for Drupal 7, part 1: Installation and image field integration on Vimeo
• Colorbox for Drupal 7, part 2: Inline images with the Insert module on Vimeo

Modules that have built in support for Colorbox

• Embedded Media Field
• Gallery Assist via Gallery Assist Lightboxes
• Gallery formatter
• Get Directions
• Image Picker
• Imagecache javascript crop
• Ubercart
• more are on the way

Dependencies

Drupal 6 and 7: The Colorbox plugin installed in sites/all/libraries
Drupal 6: jQuery Update version 6.x-2.0-alpha1 or later

Colorbox needs jQuery 1.3 or later. Drupal 6 includes only version 1.2+ and therefor needs jQuery Update. Drupal 7 ships with jQuery 1.4+ so nothing extra is needed.

When the Libraries API has a stable release Colorbox will most likely add a dependency for it.

Migrating from the Thickbox module

Colorbox is the recommended upgrade path for Thickbox users moving to Drupal 7. All Thickbox features has been ported over and Colorbox should work well as a drop in replacement. Please test it out now and give us your feedback.

You will need to go through your Display fields settings for each node type and each view.

Similar modules

Please read the article Comparison of Lightbox-type modules. Colorbox is not included yet however.