Colorbox

Colorbox is a light-weight, customizable lightbox plugin for jQuery 1.3 through 1.6. This module allows for integration of Colorbox into Drupal.

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

For Drupal 6 users

I have had reports that the latest version of the Colorbox plugin, 1.3.19, needs jQuery 1.4. I suggest Drupal 6 users stay with version 1.3.18 of the plugin. It can be downloaded from the issue below.

#1370196: Drupal 6 jQuery version to old for Colorbox plugin version 1.3.19 and later

Features

The Colorbox module:

• Excellent integration with Imagefield, Imagecache and Insert modules
• Integration Image module
• 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.
• Drush command to download and install the Colorbox plugin in sites/all/libraries.

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 3+, Safari 4+, Chrome, Internet Explorer 6, 7, 8, 9, Opera 11.
• 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
• Colorbox for Drupal 7, part 3: Building a image gallery and a image slideshow.

Contributed screencasts:

• Creating and Theming a Node Photo Gallery with Drupal 7 and Colorbox by High Rock Media.

Failed form support in Colorbox and a new beginning

Use Modal forms (with ctools) instead.

The attempt to support opening various forms in a Colorbox was in hindsight never a good idea. It will most likely be completely removed from the module. Form error handling and form redirects are complicated, a lot of code would be needed to do it correctly.

Fortunately the Chaos tool suite (ctools) has all the needed code already. There is no point and click solution however, a custom module is needed to implement it. That's the reason Modal forms module is being developed. Please try it out.

Modules that have built in support for Colorbox

• Embedded Media Field (Enable Colorbox load in the settings.)
• Media Gallery (Make use of the same Colorbox plugin but has it own integration code for it.)
• Field Slideshow
• Gallery Assist via Gallery Assist Lightboxes
• Gallery formatter
• Get Directions
• Image Picker
• Imagecache javascript crop
• Ubercart
• more are on the way

Dependencies

• The Colorbox plugin installed in sites/all/libraries
• Drupal 6 only: 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.

Recommended

• Libraries API module. If installed Colorbox will use it to find the Colorbox plugin.

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.

Downloads