1 // -----------------------------------------------------------------------------------
4 // by Lokesh Dhakar - http://www.lokeshdhakar.com
5 // Last Modification: 2/9/08
7 // For more information, visit:
8 // http://lokeshdhakar.com/projects/lightbox2/
10 // Licensed under the Creative Commons Attribution 2.5 License - http://creativecommons.org/licenses/by/2.5/
11 // - Free for use in both personal and commercial projects
12 // - Attribution requires leaving author name, author link, and the license info intact.
14 // Thanks: Scott Upton(uptonic.com), Peter-Paul Koch(quirksmode.com), and Thomas Fuchs(mir.aculo.us) for ideas, libs, and snippets.
15 // Artemy Tregubenko (arty.name) for cleanup and help in updating to latest ver of proto-aculous.
17 // -----------------------------------------------------------------------------------
24 Lightbox Class Declaration
29 - resizeImageContainer()
34 - disableKeyboardNav()
36 - preloadNeighborImages()
43 // -----------------------------------------------------------------------------------
48 LightboxOptions = Object.extend({
49 fileLoadingImage: 'lightbox2/images/loading.gif',
50 fileBottomNavCloseImage: 'lightbox2/images/closelabel.gif',
52 overlayOpacity: 0.8, // controls transparency of shadow overlay
54 animate: true, // toggles resizing animations
55 resizeSpeed: 7, // controls the speed of the image resizing animations (1=slowest and 10=fastest)
57 borderSize: 10, //if you adjust the padding in the CSS, you will need to update this variable
59 // When grouping images this is used to write: Image # of #.
60 // Change it for non-english localization
63 }, window.LightboxOptions || {});
65 // -----------------------------------------------------------------------------------
67 var Lightbox = Class.create();
69 Lightbox.prototype = {
71 activeImage: undefined,
74 // Constructor runs on completion of the DOM loading. Calls updateImageList and then
75 // the function inserts html at the bottom of the page which is used to display the shadow
76 // overlay and the image container.
78 initialize: function() {
80 this.updateImageList();
82 this.keyboardAction = this.keyboardAction.bindAsEventListener(this);
84 if (LightboxOptions.resizeSpeed > 10) LightboxOptions.resizeSpeed = 10;
85 if (LightboxOptions.resizeSpeed < 1) LightboxOptions.resizeSpeed = 1;
87 this.resizeDuration = LightboxOptions.animate ? ((11 - LightboxOptions.resizeSpeed) * 0.15) : 0;
88 this.overlayDuration = LightboxOptions.animate ? 0.2 : 0; // shadow fade in/out duration
90 // When Lightbox starts it will resize itself from 250 by 250 to the current image dimension.
91 // If animations are turned off, it will be hidden as to prevent a flicker of a
92 // white 250 by 250 box.
93 var size = (LightboxOptions.animate ? 250 : 1) + 'px';
96 // Code inserts html at the bottom of the page that looks similar to this:
98 // <div id="overlay"></div>
99 // <div id="lightbox">
100 // <div id="outerImageContainer">
101 // <div id="imageContainer">
102 // <img id="lightboxImage">
103 // <div style="" id="hoverNav">
104 // <a href="#" id="prevLink"></a>
105 // <a href="#" id="nextLink"></a>
107 // <div id="loading">
108 // <a href="#" id="loadingLink">
109 // <img src="images/loading.gif">
114 // <div id="imageDataContainer">
115 // <div id="imageData">
116 // <div id="imageDetails">
117 // <span id="caption"></span>
118 // <span id="numberDisplay"></span>
120 // <div id="bottomNav">
121 // <a href="#" id="bottomNavClose">
122 // <img src="images/close.gif">
130 var objBody = $$('body')[0];
132 objBody.appendChild(Builder.node('div',{id:'overlay'}));
134 objBody.appendChild(Builder.node('div',{id:'lightbox'}, [
135 Builder.node('div',{id:'outerImageContainer'},
136 Builder.node('div',{id:'imageContainer'}, [
137 Builder.node('img',{id:'lightboxImage'}),
138 Builder.node('div',{id:'hoverNav'}, [
139 Builder.node('a',{id:'prevLink', href: '#' }),
140 Builder.node('a',{id:'nextLink', href: '#' })
142 Builder.node('div',{id:'loading'},
143 Builder.node('a',{id:'loadingLink', href: '#' },
144 Builder.node('img', {src: LightboxOptions.fileLoadingImage})
149 Builder.node('div', {id:'imageDataContainer'},
150 Builder.node('div',{id:'imageData'}, [
151 Builder.node('div',{id:'imageDetails'}, [
152 Builder.node('span',{id:'caption'}),
153 Builder.node('span',{id:'numberDisplay'})
155 Builder.node('div',{id:'bottomNav'},
156 Builder.node('a',{id:'bottomNavClose', href: '#' },
157 Builder.node('img', { src: LightboxOptions.fileBottomNavCloseImage })
165 $('overlay').hide().observe('click', (function() { this.end(); }).bind(this));
166 $('lightbox').hide().observe('click', (function(event) { if (event.element().id == 'lightbox') this.end(); }).bind(this));
167 $('outerImageContainer').setStyle({ width: size, height: size });
168 $('prevLink').observe('click', (function(event) { event.stop(); this.changeImage(this.activeImage - 1); }).bindAsEventListener(this));
169 $('nextLink').observe('click', (function(event) { event.stop(); this.changeImage(this.activeImage + 1); }).bindAsEventListener(this));
170 $('loadingLink').observe('click', (function(event) { event.stop(); this.end(); }).bind(this));
171 $('bottomNavClose').observe('click', (function(event) { event.stop(); this.end(); }).bind(this));
176 'overlay lightbox outerImageContainer imageContainer lightboxImage hoverNav prevLink nextLink loading loadingLink ' +
177 'imageDataContainer imageData imageDetails caption numberDisplay bottomNav bottomNavClose';
178 $w(ids).each(function(id){ th[id] = $(id); });
184 // Loops through anchor tags looking for 'lightbox' references and applies onclick
185 // events to appropriate links. You can rerun after dynamically adding images w/ajax.
187 updateImageList: function() {
188 this.updateImageList = Prototype.emptyFunction;
190 document.observe('click', (function(event){
191 var target = event.findElement('a[rel^=lightbox]') || event.findElement('area[rel^=lightbox]');
201 // Display overlay and lightbox. If image is part of a set, add siblings to imageArray.
203 start: function(imageLink) {
205 $$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'hidden' });
207 // stretch overlay to fill page and fade in
208 var arrayPageSize = this.getPageSize();
209 $('overlay').setStyle({ width: arrayPageSize[0] + 'px', height: arrayPageSize[1] + 'px' });
211 new Effect.Appear(this.overlay, { duration: this.overlayDuration, from: 0.0, to: LightboxOptions.overlayOpacity });
213 this.imageArray = [];
216 if ((imageLink.rel == 'lightbox')){
217 // if image is NOT part of a set, add single image to imageArray
218 this.imageArray.push([imageLink.href, imageLink.title]);
220 // if image is part of a set..
222 $$(imageLink.tagName + '[href][rel="' + imageLink.rel + '"]').
223 collect(function(anchor){ return [anchor.href, anchor.title]; }).
226 while (this.imageArray[imageNum][0] != imageLink.href) { imageNum++; }
229 // calculate top and left offset for the lightbox
230 var arrayPageScroll = document.viewport.getScrollOffsets();
231 var lightboxTop = arrayPageScroll[1] + (document.viewport.getHeight() / 10);
232 var lightboxLeft = arrayPageScroll[0];
233 this.lightbox.setStyle({ top: lightboxTop + 'px', left: lightboxLeft + 'px' }).show();
235 this.changeImage(imageNum);
240 // Hide most elements and preload image in preparation for resizing image container.
242 changeImage: function(imageNum) {
244 this.activeImage = imageNum; // update global var
246 // hide elements during transition
247 if (LightboxOptions.animate) this.loading.show();
248 this.lightboxImage.hide();
249 this.hoverNav.hide();
250 this.prevLink.hide();
251 this.nextLink.hide();
252 // HACK: Opera9 does not currently support scriptaculous opacity and appear fx
253 this.imageDataContainer.setStyle({opacity: .0001});
254 this.numberDisplay.hide();
256 var imgPreloader = new Image();
258 // once image is preloaded, resize image container
261 imgPreloader.onload = (function(){
262 this.lightboxImage.src = this.imageArray[this.activeImage][0];
263 this.resizeImageContainer(imgPreloader.width, imgPreloader.height);
265 imgPreloader.src = this.imageArray[this.activeImage][0];
269 // resizeImageContainer()
271 resizeImageContainer: function(imgWidth, imgHeight) {
273 // get current width and height
274 var widthCurrent = this.outerImageContainer.getWidth();
275 var heightCurrent = this.outerImageContainer.getHeight();
277 // get new width and height
278 var widthNew = (imgWidth + LightboxOptions.borderSize * 2);
279 var heightNew = (imgHeight + LightboxOptions.borderSize * 2);
281 // scalars based on change from old to new
282 var xScale = (widthNew / widthCurrent) * 100;
283 var yScale = (heightNew / heightCurrent) * 100;
285 // calculate size difference between new and old image, and resize if necessary
286 var wDiff = widthCurrent - widthNew;
287 var hDiff = heightCurrent - heightNew;
289 if (hDiff != 0) new Effect.Scale(this.outerImageContainer, yScale, {scaleX: false, duration: this.resizeDuration, queue: 'front'});
290 if (wDiff != 0) new Effect.Scale(this.outerImageContainer, xScale, {scaleY: false, duration: this.resizeDuration, delay: this.resizeDuration});
292 // if new and old image are same size and no scaling transition is necessary,
293 // do a quick pause to prevent image flicker.
295 if ((hDiff == 0) && (wDiff == 0)){
297 if (Prototype.Browser.IE) timeout = 250;
301 this.prevLink.setStyle({ height: imgHeight + 'px' });
302 this.nextLink.setStyle({ height: imgHeight + 'px' });
303 this.imageDataContainer.setStyle({ width: widthNew + 'px' });
306 }).bind(this).delay(timeout / 1000);
311 // Display image and begin preloading neighbors.
313 showImage: function(){
315 new Effect.Appear(this.lightboxImage, {
316 duration: this.resizeDuration,
318 afterFinish: (function(){ this.updateDetails(); }).bind(this)
320 this.preloadNeighborImages();
325 // Display caption, image number, and bottom nav.
327 updateDetails: function() {
329 // if caption is not null
330 if (this.imageArray[this.activeImage][1] != ""){
331 this.caption.update(this.imageArray[this.activeImage][1]).show();
334 // if image is part of set display 'Image x of x'
335 if (this.imageArray.length > 1){
336 this.numberDisplay.update( LightboxOptions.labelImage + ' ' + (this.activeImage + 1) + ' ' + LightboxOptions.labelOf + ' ' + this.imageArray.length).show();
341 new Effect.SlideDown(this.imageDataContainer, { sync: true, duration: this.resizeDuration, from: 0.0, to: 1.0 }),
342 new Effect.Appear(this.imageDataContainer, { sync: true, duration: this.resizeDuration })
345 duration: this.resizeDuration,
346 afterFinish: (function() {
347 // update overlay size and update nav
348 var arrayPageSize = this.getPageSize();
349 this.overlay.setStyle({ height: arrayPageSize[1] + 'px' });
358 // Display appropriate previous and next hover navigation.
360 updateNav: function() {
362 this.hoverNav.show();
364 // if not first image in set, display prev image button
365 if (this.activeImage > 0) this.prevLink.show();
367 // if not last image in set, display next image button
368 if (this.activeImage < (this.imageArray.length - 1)) this.nextLink.show();
370 this.enableKeyboardNav();
374 // enableKeyboardNav()
376 enableKeyboardNav: function() {
377 document.observe('keydown', this.keyboardAction);
381 // disableKeyboardNav()
383 disableKeyboardNav: function() {
384 document.stopObserving('keydown', this.keyboardAction);
390 keyboardAction: function(event) {
391 var keycode = event.keyCode;
394 if (event.DOM_VK_ESCAPE) { // mozilla
395 escapeKey = event.DOM_VK_ESCAPE;
400 var key = String.fromCharCode(keycode).toLowerCase();
402 if (key.match(/x|o|c/) || (keycode == escapeKey)){ // close lightbox
404 } else if ((key == 'p') || (keycode == 37)){ // display previous image
405 if (this.activeImage != 0){
406 this.disableKeyboardNav();
407 this.changeImage(this.activeImage - 1);
409 } else if ((key == 'n') || (keycode == 39)){ // display next image
410 if (this.activeImage != (this.imageArray.length - 1)){
411 this.disableKeyboardNav();
412 this.changeImage(this.activeImage + 1);
418 // preloadNeighborImages()
419 // Preload previous and next images.
421 preloadNeighborImages: function(){
422 var preloadNextImage, preloadPrevImage;
423 if (this.imageArray.length > this.activeImage + 1){
424 preloadNextImage = new Image();
425 preloadNextImage.src = this.imageArray[this.activeImage + 1][0];
427 if (this.activeImage > 0){
428 preloadPrevImage = new Image();
429 preloadPrevImage.src = this.imageArray[this.activeImage - 1][0];
438 this.disableKeyboardNav();
439 this.lightbox.hide();
440 new Effect.Fade(this.overlay, { duration: this.overlayDuration });
441 $$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'visible' });
447 getPageSize: function() {
449 var xScroll, yScroll;
451 if (window.innerHeight && window.scrollMaxY) {
452 xScroll = window.innerWidth + window.scrollMaxX;
453 yScroll = window.innerHeight + window.scrollMaxY;
454 } else if (document.body.scrollHeight > document.body.offsetHeight){ // all but Explorer Mac
455 xScroll = document.body.scrollWidth;
456 yScroll = document.body.scrollHeight;
457 } else { // Explorer Mac...would also work in Explorer 6 Strict, Mozilla and Safari
458 xScroll = document.body.offsetWidth;
459 yScroll = document.body.offsetHeight;
462 var windowWidth, windowHeight;
464 if (self.innerHeight) { // all except Explorer
465 if(document.documentElement.clientWidth){
466 windowWidth = document.documentElement.clientWidth;
468 windowWidth = self.innerWidth;
470 windowHeight = self.innerHeight;
471 } else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode
472 windowWidth = document.documentElement.clientWidth;
473 windowHeight = document.documentElement.clientHeight;
474 } else if (document.body) { // other Explorers
475 windowWidth = document.body.clientWidth;
476 windowHeight = document.body.clientHeight;
479 // for small pages with total height less then height of the viewport
480 if(yScroll < windowHeight){
481 pageHeight = windowHeight;
483 pageHeight = yScroll;
486 // for small pages with total width less then width of the viewport
487 if(xScroll < windowWidth){
490 pageWidth = windowWidth;
493 return [pageWidth,pageHeight];
497 document.observe('dom:loaded', function () { new Lightbox(); });