Lightbox2 - Settings

The Lightbox2 module can be configured at Administer >> Site Configuration >> Lightbox2. Users will need the 'administer lightbox2' permission to alter the settings.

Not all of these options will be available depending on the module version you're using.

General settings
Layout settings

• Use Lightbox2 Lite - 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. The Lightbox2 Lite option does not use the jQuery library and is therefore less likely to conflict with other modules.
• Use Alternative Layout - Enabling this option alters the layout of the lightbox elements. This doesn't apply when using Lightbox Lite.
• Force visibility of navigation links - 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.
• Continuous Galleries - When viewing grouped images, the Next button on the last image will display the first image, while the Previous button on the first image will display the last image.
• Open Image Page in New Window - This controls whether the link to the image page underneath the image is opened in a new window or the current window.
• Text for Image Page Link - This is the text that will appear as the link to the image page underneath the image in the lightbox. Leave this blank for the link not to appear.
• Text for Image Original Link - This is the text that will appear as the link to the original file underneath the image in the lightbox. Leave this blank for the link not to appear.
• Image Count Text - 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". Leave blank for text not to appear.
• Page Count Text - This text is used to display the page count underneath HTML content displayed in the lightbox when using groups. Use !current as a placeholder for the number of the current page and !total for the total number of pages in the group. For example, "Page !current of !total". Leave blank for text not to appear.
• Video Count Text - This text is used to display the count underneath video content displayed in the lightbox when using groups. Use !current as a placeholder for the number of the current video and !total for the total number of videos in the group. For example, "Video !current of !total". Leave blank for text not to appear.

Image resize settings

• Disable Resizing Feature - 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.
• Disable Zoom In / Out Feature - When the image being displayed in the lightbox is resized to fit in the browser window, a "zoom in" button is shown. This allows the user to zoom in to see the original full size image. They will then see a "zoom out" button which will allow them to see the smaller resized version. Checking this box will prevent these buttons from appearing.

Modal settings

• Enable Login Support - Enabling this option will modify all login links so that the login form appears in a lightbox.
• Enable Contact Form Support - Enabling this option will modify all contact links so that the contact form appears in a lightbox.

Video Settings

• Enable Video Support - By default, video support is disabled in order to reduce the amount of javascript needed. Checking this box will enable it.
• Path to FLV Player - The path to the FLV player, relative to Drupal root directory.
• FLV Player flashvars - Flashvars for the FLV Player where supported, e.g. "autoplay=1&playerMode=normal".

Page Specific Lightbox2 Settings

• Enable Lightbox2 on Specific Pages - Here the user has the choice to configure a list of pages on which the lightbox will be triggered, or a list of pages on which the lightbox should not be triggered. List one page per line as Drupal paths. The % character is a wildcard in the Drupal 5 version, whereas the * character is the wildcard in Drupal 6. Example paths are "node/add/page" and "node/add/*". Use to match the front page.

CCK Display Settings

• Select Emfield Image Grouping in Views - By default, embedded media fields (emfields) in views are grouped by the field name they appear in the view in. You can override that grouping here to group them by node id or node id and field name.
• Select Imagefield Grouping in Views - By default, imagefields in views are grouped by the field name they appear in the view in. You can override that grouping here to group them by node id or node id and field name.
• Use Node Title as Caption - By default, the caption for imagefields is the image title text configured. If no title is configured, then the alt text will be used. This option allows you to override that and always display the node title as the image caption. If images are coming from an image field (in Views for example) ensure the ALT and TITLE attributes are enabled and populated.

Advanced Settings

• Location of Javascript - 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.
• Click on overlay or lightbox to close it - Enable user to close lightbox by clicking on the lightbox itself or the overlay background.
• Keyboard shortcuts
  • Configure the keyboard shortcuts for controlling the lightbox. These options do not apply to the Lightbox2 Lite version, which uses the default "Close keys" (c, x and esc) to close the lightbox.
  • Close keys - A list of keys (or key codes) that a user may use to close the lightbox. Values should be separated by a space. Defaults to 'c x 27' (c, x, or esc).
  • Previous keys - A list of keys (or key codes) that a user may use to navigate to the previous item in the lightbox. Values should be separated by a space. Defaults to 'p 37' (p or left arrow).
  • Next keys - A list of keys (or key codes) that a user may use to navigate to the next item in the lightbox. Values should be separated by a space. Defaults to 'n 39' (n or right arrow).
  • Zoom keys - A list of keys (or key codes) that a user may use to zoom in / out of images in the lightbox. Values should be separated by a space. Defaults to 'z'.
  • Pause / play keys - A list of keys (or key codes) that a user may use to pause / play the lightbox. Values should be separated by a space. Defaults to '32' (spacebar).
• Skin settings
  • Border Size - Enter the size of the border in pixels to display around the image.
  • Lightbox Color - Enter a hexadecimal color value for the border. For example fff or ffffff for white).
  • Font Color - Enter a hexadecimal color value for the font. For example 000 or 000000 for black).
  • Distance from top - Enter the position of the top of the lightbox in pixels. Leave blank for automatic calculation.
• Overlay settings
  • Overlay Opacity - 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.
  • Overlay Color - Enter a hexadecimal color value for the overlay. For example 000 or 000000 for black).
• Animation settings - These options aren't available when using Lightbox2 Lite.
  • Resize Sequence - The sequence to use for the resizing animation.
  • Resize Duration - The duration (in seconds) of the resizing animation. Enter a value between 0 and 10.
  • Appearance Duration - The duration (in seconds) of the lightbox appearance animation. Enter a value between 0 and 10.
  • Caption Slide Down Duration - The duration (in seconds) of the caption sliding-down animation. Enter a value between 0 and 10.

Slideshow options

• Interval Seconds - The slideshow interval is the length of time in seconds an image is visible before the slideshow shows the next image.
• Automatically start slideshow - When enabled the slideshow will automatically start.
• Automatically Exit Slideshow - Enabling this option will cause the lightbox to automatically close after displaying the last image.
• Show Play / Pause Button - If enabled, a play / pause button will be shown in the slideshow allowing the user more control over their viewing experience.
• Pause Slideshow on "Next Image" Click - When enabled the slideshow is automatically paused, and the following image shown, when the "Next" button is clicked.
• Pause Slideshow on "Previous Image" Click - When enabled the slideshow is automatically paused, and the previous image shown, when the "Previous" button is clicked.
• Continuous Loop - When enabled the slideshow will automatically start over after displaying the last slide. This prevents the slideshow from automatically exiting when enabled.

HTML Content (iframe) options

• Default Width - The default width of the iframe in pixels.
• Default Height - The default height of the iframe in pixels.
• Enable Border - Enable iframe border. You can modify the border style in your theme's css file using the iframe's id "lightboxFrame".

Automatic image node options
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. Only image nodes which have the CSS classes "inline", "thumbnail" or "image-thumbnail" will have their URLs automatically re-formatted. This feature is not available when using Lightbox2 Lite.

Automatic Handlers

• Image Node Settings
  • Automatic handler for Image Nodes - Choose how URLs for image nodes will be automatically handled.
  • Lightbox image display size - Select which image size will be loaded in the lightbox. This only applies to images uploaded with the Image module.
  • Image trigger size - Select which image size, when clicked on, will automatically trigger the lightbox. This only applies to images uploaded with the Image module.
  • Disable Lightbox for Gallery Lists - Checking this box will disable the lightbox for images in gallery lists, but will still use the lightbox when viewing gallery images. This is useful when you want to be able to click on an image to enter the gallery but you want to have the lightbox appear when you click on a image when viewing the contents of a gallery.
• Flickr Images
  • Automatic handler for Flickr images - Choose how URLs for Flickr images will be automatically handled.
• Gallery2 Images
  • Automatic handler for Gallery2 block images - Choose how URLs for images, contained within Gallery2 image blocks, will be automatically handled.
• Inline Images
  • Automatic handler for Inline images - Choose how URLs for Inline images will be automatically handled.
• Image Assist Images
  • Automatic handler for Image Assist custom size images - Choose how URLs for custom size images, displayed by the Image Assist module, will be automatically handled.
• Custom Class Images
  • Automatic handler for custom class images - Choose how URLs for custom class images will be automatically handled.
  • Custom image trigger classes - List the image classes which should trigger the lightbox when clicked on. Put each class on a separate line.
• Acidfree Settings
  • Disable Lightbox for Acidfree Gallery Lists - Checking this box will disable the lightbox for images in acidfree gallery lists, but will still use the lightbox when viewing gallery images. This is useful when you want to be able to click on an image to enter the gallery but you want to have the lightbox appear when you click on a image when viewing the contents of a gallery. This only applies to image galleries created with the "acidfree" module.
  • Enable Lightbox for Acidfree Videos - Checking this box will enable the display of acidfree videos in a lightbox. This only applies to videos created by the "video" module and which appear in an acidfree gallery.