jQuery Photo Slide Show with Slick Caption Tutorial Revisited

Written by Kevin Liew on 16 Dec 2009
266,252 Views • Tutorials

Introduction

If you have been reading my website from the start you would have read this tutorial:

Simple jQuery Image Slide Show with Semi Transparent Caption

It's a very famous post because it has been showcased in several major web design blogs so many times and I received a lot of traffic from it. Thanks guys. I get a lot of comment and as I replied to those comments and do some quick fixes, I realized that this script has a caption bug and inefficient and not up to standard (oh well, that's the time when I was start picking up jQuery :)), so I have decided to do revisit to solve all those problems discovered by readers. I rewrote the html structure and modify the script.

Mission Objectives:

  • Restructure the HTML, more semantic
  • Fix the caption bug, it displays the next caption too fast
  • W3C standard compliant, using appropriate attribute to store title and description
  • Cross Browser - Chrome, Safari, IE6, 7, 8 and Firefox.

However, one thing though, it needs javascript, if your browser is javascript disabled, sorry, there is no graceful degradation for this script, it will just display the first item.

Advertisement

1. HTML

Yes, I'm using list this time :) This is how it should have been afterall. No more REL attribute, we wil be using TITLE Attribute to store the heading and ALT attribute to store the description. For the caption elements, it will be added using jQuery. So, this is it - a clean and simple HTML code.

<ul class="slideshow">
	<li class="show"><a href="#"><img data-src="images/s1.gif" width="450" height="200" title="Slide 1" alt="Short Description"/></a></li>
	<li><a href="#"><img data-src="images/s2.gif" width="450" height="200" title="Slide 2" alt="Short Description"/></a></li>
	<li><a href="#"><img data-src="images/s3.gif" width="450" height="200" title="Slide 3" alt="Short Description"/></a></li>
</ul>

2. CSS

CSS code is rewritten completely. I guarantee it's cross browser compliant. They all look identical and it works great :) I did learn a lot of CSS technique through this blog. We all can improve our skills through tips, tricks, trials and errors. Read these posts to learn more about CSS:

body {
	font-family:arial;	
	font-size:12px;
}

ul.slideshow {
	list-style:none;
	width:450px;
	height:200px;
	overflow:hidden;
	position:relative;
	margin:0;
	padding:0;
	
}	

ul.slideshow li {
	position:absolute;
	left:0;
	right:0;
}

ul.slideshow li.show {
	z-index:500;	
}

ul img {
	border:none;	
}

#slideshow-caption {
	width:450px;
	height:70px;
	position:absolute;
	bottom:0;
	left:0;	
	color:#fff;
	background:#000;
	z-index:500;
}

#slideshow-caption .slideshow-caption-container {
	padding:5px 10px;	
	z-index:1000;	
}

#slideshow-caption h3 {
	margin:0;
	padding:0;	
	font-size:14px;
}

#slideshow-caption p {
	margin:5px 0 0 0;
	padding:0;
}

3. Javascript

We will going to use call back function to display caption. This will solve the "Caption Is Appearing Before The Next Slide Syndrome" :). Not too much of changes in javascript but I do added a feature though. On mouse over the slide will pause, and resume it back on mouse out. I think it's a good touch.

$(document).ready(function() {		
	
	//Execute the slideShow, set 4 seconds for each images
	slideShow(2000);

});

function slideShow(speed) {


	//append a LI item to the UL list for displaying caption
	$('ul.slideshow').append('
  •  
'); //Set the opacity of all images to 0 $('ul.slideshow li').css({opacity: 0.0}); //Get the first image and display it (set it to full opacity) $('ul.slideshow li:first').css({opacity: 1.0}).addClass('show'); //Get the caption of the first image from REL attribute and display it $('#slideshow-caption h3').html($('ul.slideshow li.show').find('img').attr('title')); $('#slideshow-caption p').html($('ul.slideshow li.show').find('img').attr('alt')); //Display the caption $('#slideshow-caption').css({opacity: 0.7, bottom:0}); //Call the gallery function to run the slideshow var timer = setInterval('gallery()',speed); //pause the slideshow on mouse over $('ul.slideshow').hover( function () { clearInterval(timer); }, function () { timer = setInterval('gallery()',speed); } ); } function gallery() { //if no IMGs have the show class, grab the first image var current = ($('ul.slideshow li.show')? $('ul.slideshow li.show') : $('#ul.slideshow li:first')); //trying to avoid speed issue if(current.queue('fx').length == 0) { //Get next image, if it reached the end of the slideshow, rotate it back to the first image var next = ((current.next().length) ? ((current.next().attr('id') == 'slideshow-caption')? $('ul.slideshow li:first') :current.next()) : $('ul.slideshow li:first')); //Get next image caption var title = next.find('img').attr('title'); var desc = next.find('img').attr('alt'); //Set the fade in effect for the next image, show class has higher z-index next.css({opacity: 0.0}).addClass('show').animate({opacity: 1.0}, 1000); //Hide the caption first, and then set and display the caption $('#slideshow-caption').slideToggle(300, function () { $('#slideshow-caption h3').html(title); $('#slideshow-caption p').html(desc); $('#slideshow-caption').slideToggle(500); }); //Hide the current image current.animate({opacity: 0.0}, 1000).removeClass('show'); } }

Updates

2010-09-10: Thanks to Rezzie who nailed the IE8 issue! :)

Updated the article and scripts, the link issue is fixed. :) Sorry for the delay.

Speed Issue

This is one of the issue that has been haunted me for a while, but thanks to Sam, one of our reader, he pointed out this would solve the issue, but with mixed result in IE.

Sam's solution, you need to add this:

$(window).focus(function () {
	timer = setInterval('gallery()', speed); 
});
$(window).blur(function () {
	clearInterval(timer);
});

James Burnett's solution, you modify the gallery function():

function gallery() {
	var current = ($('ul.slideshow li.show')? $('ul.slideshow li.show') : $('#ul.slideshow li:first'));

	if(current.queue('fx').length == 0) {
		
		// grab next image and animate code in here
		......
		......
		......
		
	}
}

Also, did some research, found the reason why it's doing it: From jQuery Animate Documentation: Because of the nature of requestAnimationFrame(), you should never queue animations using a setInterval or setTimeout loop. In order to preserve CPU resources, browsers that support requestAnimationFrame will not update animations when the window/tab is not displayed. If you continue to queue animations via setInterval or setTimeout while animation is paused, all of the queued animations will begin playing when the window/tab regains focus. To avoid this potential problem, use the callback of your last animation in the loop, or append a function to the elements .queue() to set the timeout to start the next animation.

Sorry guys, I don't have time to put all these together. Please let me know it works.

Randomize Slides

Simple yet effective solution from another reader - Blastos

Before the ending of function slideShow(), put this in:

//Generate a random number
var randNum = Math.floor(Math.random() * $('ul.slideshow li').length);

//Randomly pick up a slide
$('ul.slideshow li:eq('+randNum+')').addClass('show');

Caption doesn't appear for the first slide

I think it has to be the ommitted A tag for some users. Ammended the script, it should be fixed now.

Conclusion

I have made a lot of tutorials, and I think it's good to do a revisit to make it more efficient and solve some of the annoying bugs instead of quick fixes. So, yea, from now on, I will check my previous tutorials and rewrite them. :)

Like this tutorials? You can express your gratitude by visiting my sponsors on the sidebar, bookmark it and help me to spread this tutorial to our friends! :) Thanks!

Demo Download
Join the discussion

Comments will be moderated and rel="nofollow" will be added to all links. You can wrap your coding with [code][/code] to make use of built-in syntax highlighter.

488 comments
Jim 16 years ago
I found a potential work around to the caption not changing in IE8. It looks like the title/caption and description are being set OK, its just that IE8 is not refreshing. Possibly because the LI element is opacity is being set first.

The workaround I cam up with was to move the setting of html for the h3 and p elements above the call to
$('#slideshow-caption').animate

But only in dear old IE8. I'm pretty new to jquery so please don't take my word on this. If you have a better solution I would really like to hear it. I really like this slideshow alot but without this workaround or another/better solution I can't use the slideshow.
Reply
Adam 16 years ago
I have noticed with IE8 if you change:

$('#slideshow-caption').animate({bottom:-70}, 300, function () {

to

$('#slideshow-caption').animate({bottom:0}, 300, function () {

(note -70 to 0)

the caption will change, it is when it goes to the bottom it will not work.

Any ideas?
Reply
Jim 16 years ago
Adam, by changing the bottom value from -70 to 0 you are not fully hiding the caption, right?

The -70 value guarantees that the caption is completely hidden since the caption's height is 70.
Reply
Valery 16 years ago
I'm a newbie programmer and I was trying to install this slideshow on a website that runs on a publishing platform. I keep getting an error message that says:

$("ul.slideshow") is null

Is anyone else getting this message? Or better yet, does anyone know how I can fix this? Thanks.
Reply
Valery 16 years ago
I found out what my problem was. I used the jQuery.noConflict() function and forgot to change all the '$' to 'jQuery' in the js file.
Reply
Valery 16 years ago
I forgot to thank you for this wonderful slideshow and for the tutorial! I stumbled upon this blog by accident and I love it; you have so much amazing stuff on your website.
Reply
musika 16 years ago
I have question regarding the tranition of the image and caption.its too fast.how can I set the time interval of eacvh slide..please answer or email me
Reply
kevin Admin 16 years ago
@musika: Yes, they are adjustable. Just look for the animate method, you can just the miliseconds to your desired speed.
Reply
Grace 16 years ago
Thanks for the slideshow! I used the hide/show suggestion from another comment and it works in IE8, although the transition is not as smooth. I hate IE8, but I love your slideshow.
Reply
mauricio 16 years ago
Hi,
Amazing tutorial and great script.
I was able to customize it to my needs (the title and the caption will show on a side box, not overlayed on the image).
I noticed something odd however: in all the browsers I've tested the very first loop seems to choke. All the images go very fast, then there's a pause where I don't see any images, and then all the next loops onwards work like a charm.
Does anyone have suggestions as for why this is happening? The images are coming from a cms, so I wonder if any delays affect the slide show?
Reply
mauricio 16 years ago
I should have added this in my previous posting. I tested the script with images already embedded in the page and it works flawlessly. So it only presents this strange behavior (images crossfading too fast the first time, then an empty box, and then everything fine after the first loop) when I am pulling the images out of a cms.
I wonder what can I do to improve this situation? Any tips are greatly appreciated.
Reply
Matt 16 years ago
Does anyone know how to modify the jQuery script to suppress the sliding caption completely if there is no caption for that image? At the moment I just get a blank transparent square slide into place which is too distracting. I have tried using the jQuery ".not" modifier but my jQuery skills are too poor to get it working. Thanks.
Reply
Matt 16 years ago
Does anybody know how to modify this script so that it can suppress the caption box when there is no caption text, but still show it for the others? I a novice with jQuery and my hacking has just left captions broken :-( Thanks.
Reply