Overview
LightboxEx JS is a simple, unobtrusive script used to overlay images on the current page, display sets of images and create slideshows using your favorite tunes. It's a snap to setup and works on all modern browsers.
What's New in this Version
- Image slideshows: group related images and play them with background music
- Customize slideshow with parameters: width, heigh, slide duration, etc.
- No waiting for a page to be loaded: LightboxEx can start showing images while the entire page is still loading.
- PNG graphics support for IE: yes!
How to Use:
Part 1 - Setup
- Lightbox
v2.0 uses the Prototype Framework and Scriptaculous Effects Library.
You will need to include these four Javascript files in your header.
<script type="text/javascript" src="js/prototype.js"></script> <script type="text/javascript" src="js/scriptaculous.js?load=effects"></script> <script type="text/javascript" src="js/Sound.js"></script> <script type="text/javascript" src="js/lightboxEx.js"></script>
- Include the Lightbox CSS file (or append your active stylesheet with the Lightbox styles).
<link rel="stylesheet" href="css/lightboxEx.css" type="text/css" media="screen" />
- Check the CSS and make sure the referenced
prev.gif
andnext.gif
files are in the right location. Also, make sure the image files as referenced near the top of thelightboxEx.js
file are in the right location. You would need to sethomeURL
variable pointing to your installation directory.
Part 2 - Activate
- Add a
rel="lightbox"
attribute to any link tag to activate the lightbox. For example:
Optional: Use the<a href="images/image-1.jpg" rel="lightbox" title="my caption">image #1</a>
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:
No limits to the number of image sets per page or how many images are allowed in each set. Go nuts!<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>
- By default, sets images are displayed in slideshow mode. You can change any default parameters by going to configuration section in
lightboxEx.js
file. Make shure you sethomeURL
variable pointing to your installation directory. - You can set the following parameters to customize your slideshow by adding them as attributes to the first link of your images from slideshow:
startslideshow = true
slideshow auto start. Set tofalse
if you want to disable starting slideshow automaticaly.
slideshowwidth = 604
set it to -1 to size slideshow window based on each image.
slideshowheight = 454
set it to -1 to size slideshow window based on each image.
navbarWidth = -1
set it to -1 to size navigation bar based on width of each image.
slideDuration = 4
set image swap interval in seconds.
loopMusic = true
loops music if it is shorter then slideshow.
forever = false
Setfalse
if want to stop on the last image or Set it totrue
for Infinite loop feature.
music = "music/song.mp3"
URL to your misic MP3 file.
For example:<a href="http://www.huddletogether.com/projects/lightbox2/images/image-3.jpg" rel="lightbox[plants]" slideshowwidth=-1 slideshowheight=-1 music="music/song.mp3" ></a>
Download:
Support:
- It doesn't work at all. The image opens up in a new page. What's wrong?
- This is commonly caused by a conflict between JS scripts. Check your body tag and look for an onload attribute. Example:
<body onload="MM_preloadImages(‘/images/menu_on.gif’)…;">
A quick fix to this problem is to append theinitLightbox()
to the onload attribute as so:
<body onload="MM_preloadImages(‘/images/menu_on.gif’)…;initLightbox()">
- Flash objects appear through overlay.
- Refer to comment by netasceta.
- Script doesn't work with imagemaps.
- Refer to comment by Jason Buechler.
- The shadow overlay doesn't stretch to cover full browser window.
- Remove the default margin and padding from the body tag. Add
body{ margin: 0; padding: 0; }
to your stylesheet. - Can I insert links in the caption?
- Yes, but you need to convert quotes and greater and less than symbols into their html entity equivalents. For example:
<a href="images/image-4.jpg" rel="lightbox" title="<a href="link.html">my link</a>">Image</a>
- Can I display flash, video, or other content using the script?
- Not out of the box, but if you're feeling brave, open up and modify the code to suit your needs. As an alternative, you can give Cody Lindley's ThickBox script a go.
- Can I use the script in a commercial project?
- Yes. It is licensed under the Creative Commons Attribution 2.5 License.
Contact:
For discussing bugs, asking questions, and troubleshooting the script use the messageboard. Thank you very much.
If you want to send me a note, response time my vary, my email: ahavriluk@yahoo.com