Colorbox | Drupal.org
Skip to search
Can we use first and third party cookies and web beacons to
understand our audience, and to tailor promotions you see
Primary tabs
View
(active tab)
Version control
114
people starred this project
Colorbox
is a light-weight customizable lightbox plugin for jQuery. 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.
Features
The Colorbox module:
Works as a Formatter in entities and in views.
Excellent integration with core image field and image styles and the
Insert
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, drush colorbox-plugin, to download and install the Colorbox plugin in sites/all/libraries.
The Colorbox plugin:
Compatible with modern versions of jQuery in all major browsers.
Supports photos, grouping, slideshow, ajax, inline, and iframed content.
Lightweight: 10KB of JavaScript (less than 5KBs gzipped).
Appearance is controlled through CSS so it can be restyled.
Can be extended with callbacks & event-hooks without altering the source files.
Completely unobtrusive, options are set in the JS and require no changes to existing HTML.
Preloads upcoming images in a photo group.
Released under the MIT License
The plugin must be downloaded separately. You can do so with the following drush command:
drush colorbox:plugin
For version 2.2.x, you
must
use the Turbojet fork of the colorbox plugin. If the above drush command isn't working for you, you can download the plugin from
For versions 2.1.x and earlier, you can continue to use the end-of-life original plugin from Jack Moore:
Supporting HTML captions
If you wish to use HTML in your Colorbox captions, you must also download and install the
DOMPurify
library. This library is optional. If you do not install it, all captions will be converted to plain text.
Colorbox for Modern Drupal
Colorbox for Drupal 8-11 is an image field formatter and nothing more, or less. The extra features like
colorbox_load
and
colorbox_inline
can be found in contrib.
If you are using the DOMPurify library, you can use
drush colorbox:dompurify
to install the library. It looks for the library in
libraries/DOMPurify/dist/purify.min.js
Colorbox for Drupal 7
Installation for Drupal 7
Download and install the
Libraries API 2
module and the Colorbox module as normal. Then download the Colorbox plugin. Make sure to use the 1.x branch since that will stay backwards compatible with older jQuery version, like the ones included with Drupal.
Download Colorbox plugin 1.x (legacy version from Jack Moore)
Unpack and rename the plugin directory to "colorbox" and place it inside the "sites/all/libraries" directory. Make sure the path to the plugin file becomes: "sites/all/libraries/colorbox/jquery.colorbox-min.js"
If you are also using the DOMPurify library to support HTML captions, install it in:
sites/all/libraries/DOMPurify/purify.min.js
Colorbox screencasts
Part 1 to 3 is for an older 7.x-1.x version of the Colorbox module.
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:
Drupal 7 Colorbox module
by Code Karate
Creating and Theming a Node Photo Gallery with Drupal 7 and Colorbox
by High Rock Media.
How to Build a Lightbox Portfolio in Drupal 7
by CMS Quickstart
Modules that extend Colorbox
Field Group Colorbox
- Provides fieldgroups for Colorbox triggers and for Colorbox popups.
Colorbox Node
- Open nodes and webforms in a Colorbox.
Field formatter for colorbox module
Media Colorbox
- Integrates Colorbox with the Media module.
Modules that have built in support for Colorbox
Video Embed Field
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
Flickr
Directory based organisational layer
Gallery Assist
via
Gallery Assist Lightboxes
Gallery formatter
Get Directions
Googtube
Image Picker
Imagecache javascript crop
Ubercart
Slick Carousel
Dependencies
2.2.x versions: the
Turbojet fork of the Colorbox library.
All older versions:
The Colorbox plugin 1.x
Modern Drupal: installed in the libraries directory so the path becomes "libraries/colorbox/jquery.colorbox-min.js"
Drupal 7.x and older: installed in sites/all/libraries directory so the path becomes "sites/all/libraries/colorbox/jquery.colorbox-min.js"
Drupal 7.x-2.x only:
Libraries API 2
Drupal 6 only: The
Old 1.3.18 version
of the Colorbox plugin and
jQuery Update
module version 6.x-2.0-alpha1 or later
The easiest way to download and install the plugin is via the built in Drush command,
drush colorbox:plugin
Credits: Colorbox logo by
Nico Grienauer (Grienauer)
Sponsor
Continued maintenance of this module is supported by
Turbojet Technologies
Supporting organizations:
Turbojet Technologies
Current maintainer: security updates and maintenance for 7.x and 2.x branches
Ramsalt Lab
Drupal 8/9 maintenance and development
Fredrik Jonsson – xdeb.net
Paid time
CI&T
Development and bug fixing
Cheeky Monkey Media
Development and bug fixing
Project information
Seeking co-maintainer(s)
Maintainers are looking for help reviewing issues.
Maintenance fixes only
Considered feature-complete by its maintainers.
Project categories:
Content display
Developer tools
Integrations
134,390
sites report using this module
Created by
jdwfly
on
13 November 2009
, updated
26 January 2026
Stable releases for this project are covered by the
security advisory policy
Look for the shield icon below.
Releases
2.2.0
released 26 January 2026
Works with Drupal: ^10.2 || ^11
Uses new Turbojet fork of the colorbox library to ensure compatibility with jQuery 4.
Install:
Development version:
2.2.x-dev
updated 26 Jan 2026 at 16:09 UTC
2.1.4
released 28 April 2025
Works with Drupal: ^10.2 || ^11
Bug fix regarding colorbox links with relative URLs
Install:
Using Composer to manage Drupal site dependencies
View all releases
Maintainers
paulmckibben
jenlampton
renatog
Issues for Colorbox
To avoid duplicates, please search before submitting a new issue.
All issues
48 open
RTBC
1,525 total
Bug report
24 open
RTBC
445 total
Statistics
New issues
Response rate
1st response
hours
Open bugs
Participants
2 year graph, updates weekly
Resources
Read license
Try out a demonstration
View project translations
Projects that extend this
Development
Source code
Issues
Commit log
GitLab activity
Report a security vulnerability
View change records
Infrastructure management for Drupal.org provided by
Need a Drupal 7 extended support partner? Consider Tag1.
News items
News
Planet Drupal
Social media
Sign up for Drupal news
Security advisories
Jobs
Our community
Community
Services
Training
Hosting
Contributor guide
Groups & meetups
DrupalCon
Code of conduct
Documentation
Documentation
Drupal Guide
Drupal User Guide
Developer docs
API.Drupal.org
Drupal code base
Download & Extend
Drupal core
Modules
Themes
Distributions
Governance of community
About
Web accessibility
Drupal Association
About Drupal.org
Drupal is a
registered trademark
of
Dries Buytaert