Overview

Lightbox JS V2 is a simple, unobtrusive script used to overlay images on the current page. It\'s a snap to setup and works on all modern browsers. The module comes with a Lightbox2 Lite option which does not use the jQuery libraries; it is therefore less likely to conflict with anything else.

Places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths. 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 when the "Lightbox2 Lite" option is enabled.

Usage

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

<a href="image-1.jpg" rel="lightbox" title="my caption">image #1</a>

Optional: Use the title attribute if you want to show a caption.

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="images/image-1.jpg" rel="lightbox[roadtrip]">image #1</a>
<a href="images/image-2.jpg" rel="lightbox[roadtrip]">image #2</a>
<a href="images/image-3.jpg" rel="lightbox[roadtrip]">image #3</a>

No limits to the number of image sets per page or how many images are allowed in each set. Go nuts!

'); break; } } /** * Implementation of hook_perm() * Define the permissions this module uses */ function lightbox2_perm() { return array('administer lightbox2'); } /** * Implementation of hook_menu() */ function lightbox2_menu($may_cache) { $items = array(); if ($may_cache) { $items[] = array('path' => 'admin/settings/lightbox2', 'title' => t('Lightbox2'), 'callback' => 'lightbox2_settings_page', 'access' => user_access('administer lightbox2'), 'description' => t('Allows the user to configure the lightbox2 settings'), ); $items[] = array('path' => 'admin/settings/lightbox2/general', 'title' => t('General'), 'callback' => 'drupal_get_form', 'callback arguments' => array('lightbox2_general_settings_form'), 'access' => user_access('administer lightbox2'), 'description' => t('Allows the user to configure the lightbox2 settings'), 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => 0, ); $items[] = array('path' => 'admin/settings/lightbox2/automatic', 'title' => t('Automatic image handling'), 'callback' => 'drupal_get_form', 'callback arguments' => array('lightbox2_auto_image_handling_settings_form'), 'access' => user_access('administer lightbox2'), 'description' => t('Allows the user to configure the lightbox2 automatic image handling settings'), 'type' => MENU_LOCAL_TASK, 'weight' => 1, ); } else { if (lightbox2_exclude_these_paths() != 1) { lightbox2_add_files(); } } return $items; } function lightbox2_settings_page($op = NULL) { $output .= drupal_get_form('lightbox2_general_settings_form'); return $output; } /** * Implementation of hook_settings() */ function lightbox2_general_settings_form() { // add the javascript which disables / enables form elements drupal_add_js(drupal_get_path('module', 'lightbox2') .'/js/lightbox2.js', 'module'); // enable translation of default strings for potx $default_strings = array(t('View Image Details'), t('Image !current of !total')); // Define Lightbox2 Lite fieldset. /* ------------------------------- */ $use_lite = variable_get('lightbox2_lite', false); $form['lightbox2_lite_options'] = array( '#type' => 'fieldset', '#title' => t('Lightbox2 Lite'), '#collapsible' => TRUE, '#collapsed' => !$use_lite, ); // Add Checkbox for Lightbox2 Lite. $form['lightbox2_lite_options']['lightbox2_lite'] = array( '#type' => 'checkbox', '#title' => t('Use Lightbox2 Lite'), '#description' => t('Checking this box will enable Lightbox2 Lite and will disable all of the automatic image node URL re-formatting features. It also disables all grouping features.'), '#default_value' => $use_lite, ); // Add Checkbox for Alternative Layout $form['lightbox2_use_alt_layout'] = array( '#type' => 'checkbox', '#title' => t('Use Alternative Layout'), '#description' => t('Enabling this option alters the layout of the lightbox elements. This doesn\'t apply when using Lightbox Lite.'), '#default_value' => variable_get('lightbox2_use_alt_layout', false), ); // Add Checkbox for Force Navigation display $form['lightbox2_force_show_nav'] = array( '#type' => 'checkbox', '#title' => t('Force visibility of navigation links'), '#description' => t('When viewing grouped images using the default layout, the navigational links to the next and previous images are only displayed when you hover over the image. Checking this box forces these links to be displayed all the time.'), '#default_value' => variable_get('lightbox2_force_show_nav', false), ); // Add text box for image count for grouping $form['lightbox2_image_count_str'] = array( '#type' => 'textfield', '#title' => t('Image Count Text'), '#description' => t('This text is used to display the image count underneath the image in the lightbox when image grouping is enabled. Use !current as a placeholder for the number of the current image and !total for the total number of images in the group. For example, "Image !current of !total".'), '#default_value' => variable_get('lightbox2_image_count_str', 'Image !current of !total'), ); // Add Checkbox for Zoom image $form['lightbox2_disable_zoom'] = array( '#type' => 'checkbox', '#title' => t('Disable Zoom Feature'), '#description' => t('By default, when the image being displayed in the lightbox is larger than the browser window, it is resized to fit within the window and a zoom button is provided for users who wish to view the image in its original size. Checking this box will disable this feature and all images will be displayed without any resizing.'), '#default_value' => variable_get('lightbox2_disable_zoom', false), ); // Add Textarea for urls without lightbox $form['lightbox2_disable_these_urls'] = array( '#type' => 'textarea', '#title' => t('Disable LightBox for these urls'), '#description' => t('List the urls where the lightbox should be disabled, e.g. "node/add/page". Use <front> to match the front page. Put each url on a separate line. You can use the % character as a wildcard.'), '#default_value' => variable_get('lightbox2_disable_these_urls', ''), ); // Define Advanced settings fieldset /* --------------------------------- */ $form['lightbox2_advanced_options'] = array( '#type' => 'fieldset', '#title' => t('Advanced settings'), '#collapsible' => TRUE, '#collapsed' => TRUE, ); // Add Checkbox for overlay opacity. for ($i = 0; $i < 10; $i++) { $opacity_options["0.$i"] = "0.$i"; } $opacity_options["1.0"] = "1.0"; $form['lightbox2_advanced_options']['lightbox2_overlay_opacity'] = array( '#type' => 'select', '#title' => t('Overlay Opacity'), '#options' => $opacity_options, '#description' => t('The overlay opacity setting determines how visible or transparent the background page is behind the lightbox. The opacity value can range from 0.0 to 1.0 where 0.0 is 100% transparent and 1.0 is 100% opaque.'), '#default_value' => variable_get('lightbox2_overlay_opacity', '0.6'), ); // Allow users to decide where javascript should be loaded - header or footer. // Header is recommended so user can click on images before page has finished // loading, but footer is needed for sites in IE which use SWFObject. $form['lightbox2_advanced_options']['lightbox2_js_location'] = array( '#type' => 'select', '#title' => t('Location of Javscript'), '#options' => array('header' => t('Header'), 'footer' => t('Footer')), '#description' => t('By default, the lightbox javascript files are loaded in the HTML header. However, for sites using SWFObject to load their Flash content, the footer setting is recommended to prevent "Operation Aborted" errors in IE. If using the footer setting, please note that not all themes correctly implement the footer region and may require a small change.'), '#default_value' => variable_get('lightbox2_js_location', 'header'), ); return system_settings_form($form); } function lightbox2_auto_image_handling_settings_form() { // add the javascript which disables / enables form elements drupal_add_js(drupal_get_path('module', 'lightbox2') .'/js/lightbox2.js', 'module'); // set up a hidden variable $form['lightbox2_lite'] = array( '#type' => 'hidden', '#value' => variable_get('lightbox2_lite', false), ); // Define Image Node Options fieldset. /* ----------------------------------- */ $form['image_node_options'] = array( '#value' => t('These options allow automatic URL re-formatting of Image Nodes. This removes the need for you to add \'rel="lightbox"\' to each image node link throughout your site. You can select which image sizes will trigger the lightbox and images which have the CSS classes "inline" or "flickr-photo-img" will also have their URLs automatically re-formatted. This feature is not available when using Lightbox2 Lite.'), ); // Add Checkbox for Image Node. $form['lightbox2_image_node'] = array( '#type' => 'checkbox', '#title' => t('Enable for Image Nodes'), '#description' => t('Checking this box will enable automatic URL formatting for Image Nodes.'), '#default_value' => variable_get('lightbox2_image_node', true), ); // Add DropDown for list of available image sizes. if (module_exists('image')) { $sizes = _image_get_sizes(); foreach ($sizes as $size_key => $size) { if ($size_key == 'original' || $size_key == '_original') { $size_key = ''; } $size_options[$size_key] = $size['label']; } $form['lightbox2_display_image_size'] = array( '#type' => 'select', '#title' => t('Lightbox image display size'), '#options' => $size_options, '#default_value' => variable_get('lightbox2_display_image_size', ''), '#description' => t('Select which image size will be loaded in the lightbox. This only applies to images uploaded with the Image module.'), ); $form['lightbox2_trigger_image_size'] = array( '#type' => 'select', '#multiple' => TRUE, '#title' => t('Image trigger size'), '#options' => $size_options, '#default_value' => variable_get('lightbox2_trigger_image_size', array('thumbnail' => t('Thumbnail'))), '#description' => t('Select which image size, when clicked on, will automatically trigger the lightbox. This only applies to images uploaded with the Image module.'), ); } // Add Checkbox for Flickr Image support $form['lightbox2_flickr'] = array( '#type' => 'checkbox', '#title' => t('Enable for Flickr images'), '#description' => t('Checking this box will enable automatic URL formatting for Flickr images.'), '#default_value' => variable_get('lightbox2_flickr', true), ); // Add text box for link text to node $form['lightbox2_node_link_text'] = array( '#type' => 'textfield', '#title' => t('Text for Node Link'), '#description' => t('This is the text that will appear as the link to the node underneath the image in the lightbox'), '#default_value' => variable_get('lightbox2_node_link_text', 'View Image Details'), ); // Add Checkbox for Image Node Grouping. $form['lightbox2_image_group'] = array( '#type' => 'checkbox', '#title' => t('Enable Grouping'), '#description' => t('Checking this box will enable automatic grouping of Image Nodes on a page. Useful for image galleries.'), '#default_value' => variable_get('lightbox2_image_group', true), ); // Add Checkbox for disabling lightbox for gallery lists $form['lightbox2_disable_nested_galleries'] = array( '#type' => 'checkbox', '#title' => t('Disable Lightbox for Gallery Lists'), '#description' => t('Checking this box will disable the lightbox for images in gallery lists. This means it is possible to open a gallery by clicking on the teaser image, but the lightbox will still appear when viewing images within the gallery. This only applies to image galleries created with the "image gallery" module.'), '#default_value' => variable_get('lightbox2_disable_nested_galleries', true), ); // Add Checkbox for disabling lightbox for acidfree gallery lists if (module_exists("acidfree")) { $form['lightbox2_disable_nested_acidfree_galleries'] = array( '#type' => 'checkbox', '#title' => t('Disable Lightbox for Acidfree Gallery Lists'), '#description' => t('Checking this box will disable the lightbox for images in gallery lists. This means it is possible to open a gallery by clicking on the teaser image, but the lightbox will still appear when viewing images within the gallery. This only applies to image galleries created with the "acidfree" module.'), '#default_value' => variable_get('lightbox2_disable_nested_acidfree_galleries', true), ); } return system_settings_form($form); } /** * Implementation of hook_filter(). */ function lightbox2_filter_tips($delta, $format, $long = false) { if ($delta == 0) { if (!$long) { return t('Image links with \'rel="lightbox"\' in the tag will appear in a Lightbox when clicked on.'); } else { $output = '

'. t('To add a lightbox to your images, add rel="lightbox" attribute to any link tag to activate the lightbox. For example:') .'

'; $output .= '

'. t('<a href="image-1.jpg" rel="lightbox" title="my caption">image #1</a>') .'

'; $output .= '

'. t('The title attribute in the link tag is optional. The addition of this attribute enables the display of a caption with the image displayed in the lightbox.') .'

'; $output .= '

'. t('If you have a set of related images that you would like to group, then you will need to include a group name between square brackets in the rel attribute. For example:') .'

'; $output .= '

'. t('<a href="image-1.jpg" rel="lightbox[roadtrip]">image #1</a>
<a href="image-2.jpg" rel="lightbox[roadtrip]">image #2</a>
<a href="image-3.jpg" rel="lightbox[roadtrip]">image #3</a>
') .'

'; $output .= '

'. t('There are no limits to the number of image sets per page or how many images are allowed in each set.') .'

'; $output .= '

'. t('If you wish to turn the caption into a link, format your caption in the following way:') .'

'; $output .= '

'. t('<a href="image-1.jpg" rel="lightbox" title=\'<a href="http://www.yourlink.com">View Image Details</a>\'>image #1</a>') .'

'; return $output; } } else if ($delta == 1) { return t('Image links from G2 are formatted for use with Lightbox.V2'); } } function lightbox2_filter($op, $delta = 0, $format = -1, $text = '') { switch ($op) { case 'list': return array(0 => t('Lightbox filter'), 1 => t('Lightbox G2 filter')); case 'description': if ($delta == 1) { return t('Turns g2_filter links into Lightbox.V2 appropriate links'); } else { return t('Image links with \'rel="lightbox"\' in the
tag will appear in a Lightbox when clicked on.'); } case 'process': if ($delta == 1) { $text = ' '. $text .' '; $text = preg_replace('/ShowItem/', 'DownloadItem', $text); $text = preg_replace('/target=""/', 'rel="lightbox"', $text); $text = substr($text, 1, -1); } return $text; default: return $text; } } /** * Provides a link to the CSS stylesheet associated with this module. * Provides a link to the JS file associated with this module. */ function lightbox2_add_files() { static $already_added = FALSE; if ($already_added) { return; // don't add the javascript and CSS multiple times } $already_added = TRUE; // Load required js and css files. $path = drupal_get_path('module', 'lightbox2'); // set the list of image classes to format urls for if (variable_get('lightbox2_image_node', true)) { $image_node_classes = "img.inline,"; } if (variable_get('lightbox2_flickr', true)) { $image_node_classes .= "img.flickr-photo-img,"; } $trigger_sizes = variable_get('lightbox2_trigger_image_size', array('thumbnail' => t('Thumbnail'))); foreach ($trigger_sizes as $size) { $image_node_classes .= "img.$size, img.image-$size,"; } $image_node_classes = rtrim($image_node_classes, ","); // load the javascript settings $js_settings = array( 'display_image_size' => variable_get('lightbox2_display_image_size', ''), 'overlay_opacity' => variable_get('lightbox2_overlay_opacity', '0.6'), 'use_alt_layout' => variable_get('lightbox2_use_alt_layout', false), 'disable_zoom' => variable_get('lightbox2_disable_zoom', false), 'force_show_nav' => variable_get('lightbox2_force_show_nav', false), 'image_node_classes' => $image_node_classes, 'group_images' => variable_get('lightbox2_image_group', true), 'disable_for_gallery_lists' => variable_get('lightbox2_disable_nested_galleries', true), 'disable_for_acidfree_gallery_lists' => variable_get('lightbox2_disable_nested_acidfree_galleries', true), 'node_link_text' => check_plain(t(variable_get('lightbox2_node_link_text', 'View Image Details'))), 'image_count' => check_plain(t(variable_get('lightbox2_image_count_str', 'Image !current of !total'))), 'lite_press_x_close' => t('press !x to close', array('!x' => 'x')), ); drupal_add_js(array('lightbox2' => $js_settings), 'setting'); // Check where we should load the javascript files - header or footer. $js_location = variable_get('lightbox2_js_location', 'header'); // Lightbox2 Plus if (!variable_get('lightbox2_lite', false)) { $css = $path .'/css/lightbox.css'; if (variable_get('lightbox2_use_alt_layout', false)) { $css = $path .'/css/lightbox_alt.css'; } if (function_exists('drupal_add_css')) { drupal_add_css($css); } else { theme('add_style', $css); } // Check to see if the Image Node Option is enabled in settings. if (variable_get('lightbox2_image_node', true) || variable_get('lightbox2_flickr', true)) { drupal_add_js($path .'/js/image_nodes.js', 'module', $js_location); } drupal_add_js($path .'/js/lightbox.js', 'module', $js_location); } // Lightbox Lite else { $css = $path .'/css/lightbox_lite.css'; if (function_exists('drupal_add_css')) { drupal_add_css($css); } else { theme('add_style', $css); } drupal_add_js($path .'/js/lightbox_lite.js', 'module', $js_location); } } /** * Implementation of hook_field_formatter_info(). * Adds certain lightbox+imagecache formatters to CCK image fields if the * imagefield.module and the imagecache.module exist. */ function lightbox2_field_formatter_info() { $formatter = array(); if (module_exists('imagefield') && module_exists('imagecache')) { $rules = _imagecache_get_presets(); foreach ($rules as $ruleid => $view_rule) { $formatters['lightbox2][original]['. $view_rule] = array( 'label' => 'Lightbox2: original->'. $view_rule, 'field types' => array('image'), ); $formatters['lightbox2]['. $view_rule .'][original'] = array( 'label' => 'Lightbox2: '. $view_rule .'->original', 'field types' => array('image'), ); foreach ($rules as $rid => $lightbox_rule) { $formatters['lightbox2]['. $view_rule .']['. $lightbox_rule] = array( 'label' => 'Lightbox2: '. $view_rule .'->'. $lightbox_rule, 'field types' => array('image'), ); } } } return $formatters; } /** * Implementation of hook_field_formatter(). */ function lightbox2_field_formatter($field, $item, $formatter) { if (module_exists('imagefield') && module_exists('imagecache')) { if (isset($item['filepath'])) { $filepath = &$item['filepath']; } else if (!empty($item['fid'])) { $file = _imagefield_file_load($item['fid']); $filepath = &$file['filepath']; } else { return ''; } if (lightbox2_exclude_these_paths() != 1) { lightbox2_add_files(); } $item = array_merge($item, (array)$file); $item['filepath'] = $filepath; if (strpos($formatter, 'lightbox2][') !== false) { list($null, $view_preset, $lightbox_preset) = explode('][', $formatter, 3); $item['view_filepath'] = $item['filepath']; if ($lightbox_preset == 'original') { $item['lightbox_filepath'] = $item['filepath']; } else { $item['lightbox_filepath'] = file_directory_path() .'/imagecache/'. $lightbox_preset .'/'. $item['filepath']; } $rules = _imagecache_get_presets(); if ($view_preset == 'original' || in_array($view_preset, (array) $rules)) { return theme('imagefield_image_imagecache_lightbox2', $view_preset, $field, $item); } } } } /** * Implementation of theme_imagefield_image_imagecache_lightbox2(). */ function theme_imagefield_image_imagecache_lightbox2($view_preset, $field, $item, $attributes = NULL) { $rel = 'lightbox'; if (variable_get('lightbox2_image_group', TRUE)) { $rel = 'lightbox[cck_image_nodes]'; } $node_link = ''; if (!empty($item['nid'])) { $node_link = '

'. l(t(variable_get('lightbox2_node_link_text', 'View Image Details')), 'node/'. $item['nid']); } $link_attributes = array( 'rel' => $rel, 'title' => $item['alt'] . $node_link); if ($view_preset == 'original') { $image = theme('lightbox2_image', $item['view_filepath'], $item['alt'], $item['title'], $attributes); } else { $image = theme('imagecache', $view_preset, $item['view_filepath'], $item['alt'], $item['title'], $attributes); } $output = l($image, file_create_url($item['lightbox_filepath']), $link_attributes, NULL, NULL, FALSE, TRUE); return $output; } function lightbox2_exclude_these_paths() { // Use lightbox if this url is not excluded $disabled_urls = variable_get('lightbox2_disable_these_urls', ''); if (!empty($disabled_urls)) { $urls = explode("\n", $disabled_urls); foreach ($urls as $url) { $url = rtrim($url); if ($url == "") { $url = ""; } $url = preg_replace('/%/', '.*?', preg_quote($url, '/')); $pattern = '/^'. $url .'$/'; if (preg_match($pattern, $_REQUEST['q'])) { return 1; } } } return 0; } function theme_lightbox2_image($path, $alt = '', $title = '', $attributes = NULL) { $attributes = drupal_attributes($attributes); $image = ''.  check_plain($alt) .''; return $image; }