Tutoriel: Réaliser un diaporama simple avec JQuery

Publié par Gui dans Développement, jQuery, Tutoriels

Facile

jQuery, css

Il existe une nouvelle version du diaporama simple avec JQuery ! Cliquez ici pour accéder aux nouveautés!

JQuery est devenu rapidement un framework de développement javascript indispensable, très pratique que ce soit pour développer de simples fonctionnalités ou des sites complets.

Souvent, lors de la création d’un site internet, on rencontre les mêmes fonctionnalités de base (des rollover sur les images, un menu déroulant, un diaporama …), et pour chacun d’entre eux, il existe quasiment un plugin JQuery qui répond à ces attentes.

Il peut être également utile de développer un plugin pour une fonctionnalité simple mais à laquelle on se trouve souvent confronté et dont on veut maîtriser le fonctionnement.

Mon premier tutoriel s’articulera donc autour de la mise en place d’un plugin JQuery simple: un diaporama Photo.

Diaporama simple avec JQuery

Introduction

Nous allons donc réaliser un diaporama de photos. Le principe étant que les photos défilent les unes après les autres avec une transition par fondu enchaîné. Nous allons aussi ajouter des boutons de contrôle pour mettre en pause le diaporama, accéder à la photo suivante ou précédente.

Première étape: partie HTML

Avant tout, il convient d’inclure la librairie JQuery dans notre page de test. Vous pouvez la trouver ici : Librairie JQuery

Ensuite, nous allons écrire une page HTML simple avec une liste de photos.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr">
	<head>
		<title>Diaporama Simple JQuery</title>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

		<!-- Cascading Style Sheets -->
		<link href="page.css" rel="stylesheet" type="text/css" />
		<link href="style.css" rel="stylesheet" type="text/css" />

		<!-- Javascript -->
		<script type="text/javascript" src="js/jquery-1.3.2.min.js"></script>
		<script type="text/javascript" src="js/jquery.diaporama.js"></script>
		<script type="text/javascript" src="js/script.js"></script>
	</head>

	<body>

		<h1>Diaporama Simple</h1>

		<ul class="diaporama">
			<li><img src="img/galerie/image1.jpg" alt="Image 1" /></li>
			<li><img src="img/galerie/image2.jpg" alt="Image 2" /></li>
			<li><img src="img/galerie/image3.jpg" alt="Image 3" /></li>
			<li><img src="img/galerie/image4.jpg" alt="Image 4" /></li>
			<li><img src="img/galerie/image5.jpg" alt="Image 5" /></li>
		</ul>

	</body>

</html>

Deuxième étape: partie CSS

Le principe de base du diaporama est de superposer les images pour ensuite les faire défiler. Nous allons donc créer une feuille de style avec les propriétés suivantes :

.diaporama{
	position:relative;
	width:512px; /* Largeur d'une photo */
	height:288px /* Hauteur d'une photo */
}

.diaporama li{
	list-style-type:none;
	overflow:hidden;
	position:absolute /* Les images seront positionnées toutes au même endroit */
}

.diaporama_controls{
	width:512px;
	margin:3px 0;
	padding:5px;
	clear:both;
	overflow:hidden;
}

.diaporama_controls .btns{
	float:right;
}

.diaporama_controls a{
	font-weight:normal;
	width:10px;
	height:13px;
	text-indent:-9999px;
	display:inline-block;
	margin:0 3px;
}

.diaporama_controls .prev{
	background:url(img/fleches_diapo.png) no-repeat top right;
}

.diaporama_controls .next{
	background:url(img/fleches_diapo.png) no-repeat top left;
}

.diaporama_controls .pause{
	background:url(img/fleches_diapo.png) no-repeat bottom right;
}

.diaporama_controls .play{
	background:url(img/fleches_diapo.png) no-repeat bottom left;
}

Je ne détaillerai pas le contenu de la feuille de style page.css, celle-ci n’est utilisée que pour la mise en page de l’index.html.

Voici le résultat que nous avons pour l’instant :

Diaporama simple avec JQuery

Troisième étape: partie JQuery

Nous allons avoir deux fichiers javascript :

  1. Notre fichier plugin « jquery.diaporama.js« 
  2. Un fichier de script, pour exécuter le diaporama « script.js« 

Instanciation du plugin Diaporama

La fonction Diaporama doit être appelée dans la page html, au chargement de la page, au moyen de la fonction JQuery $(document).ready()

Cet appel sera effectué depuis le fichier script.js :

$(document).ready(function(){

	$(".diaporama").diaporama({
		animationSpeed: "slow",
		delay:2
	});

});

On va éxécuter la fonction diaporama sur tous les éléments qui ont une classe « diaporama ».

Structure du plugin

(function($){ // 1
	$.fn.diaporama = function(options) {

		// 2 Appliquer le diaporama sur chacun des éléments ciblés
		this.each(function(){

		});

		return this;  // 3 Continuer le chainage JQuery
	};
})(jQuery);

Voici la structure de base d’un plugin JQuery :

  1. On utilise function($) pour explicitement dire qu’on va utiliser l’alias « $ » dans notre fonction
  2. La fonction diaporama va être appelée sur un élément ou un ensemble d’éléments. Il convient donc d’éxécuter pour chacun des éléments rencontrés la fonction diaporama
  3. Le chaînage permet de continuer d’appliquer des fonctions à notre sélecteur, par exemple, $(« .diaporama »).diaporama().show.fadeOut() …

Paramètres

Nous allons utiliser différents paramètres pour notre diaporama :

  1. delay: le délai de balayage des images
  2. animationSpeed: la durée de l’effet de transition
  3. controls: affichage des boutons de contrôle

Cela va se traduire dans notre script par :

var defaults = {
	delay: 3,
	animationSpeed: "normal",
	controls:true
};

var options = $.extend(defaults, options);  // 1
  1. $.extend est une fonction JQuery qui permet de créer une variable options à partir, soit de la variable defaults, soit des paramètres spécifiés dans l’appel de la fonction $.fn.diaporama = function(options)
    De ce fait, les paramètres non spécifiés dans l’appel du plugin seront ceux par défaut.

Initialisation

On va maintenant initialiser le diaporama:

  1. Vérifier que la liste contient au moins deux photos
  2. Initialiser nos variables
  3. Lancer la mécanique de rotation d’images
// On attribue à la variable obj, l'objet courant (le diaporama courant)
var obj = $(this);

// On teste si il y a plus d'une image, sinon le diaporama n'est pas nécessaire
if($(obj).find("li").length > 1){

	// On va exécuter la fonction nextElt à chaque intervalle de temps
	var inter = setInterval(function(){nextElt(options)}, (options.delay*1000));

	// On enregistre le sens de rotation
	var sens = "right";

	// Par défaut, le diaporama n'est pas en pause
	var pause = false;

	// On cache tous les éléments de la liste
	$(obj).find("li").hide();

	// Le premier élément s'affiche progressivement et se voit attribuer la classe "active"
	$(obj).find("li:first-child").addClass("active").fadeIn(options.animationSpeed);
}

Si le paramètre controls est défini à true, alors on ajoute les boutons de contrôle:

// On veut ajouter des boutons de contrôle
if(options.controls)
{
	// On insère après la liste un <div> contenant les boutons "précédent", "suivant" et "pause"
	$(obj).after("<div class='diaporama_controls'><div class='btns'><a href='#' class='prev'>Prec.</a> <a href='#' class='pause'>Pause</a> <a href='#' class='next'>Suiv.</a></div></div>");

	// On définit l'action click pour le bouton "précédent"
	// La méthode siblings() permet de trouver les éléments "frères" de l'élément courant
	$(obj).siblings().find(".prev").click(function(){
		// On supprime l'intervalle automatique de transition d'image
		clearInterval(inter);

		// On appelle la fonction qui affiche l'image précédente
		prevElt(options);

		// Si le diaporama n'est pas sur pause, on relance l'affichage automatique
		if(!pause)
			inter = setInterval(function(){prevElt(options)}, (options.delay*1000));

		// On définit le sens à gauche
		sens = "left";
	});

	// On applique la même méthode ou presque au bouton "suivant" (dans l'autre sens)
	$(obj).siblings().find(".next").click(function(){
		clearInterval(inter);
		nextElt(options);
		if(!pause)
			inter = setInterval(function(){nextElt(options)}, (options.delay*1000));
		sens = "right";
	});

	// Si on appuie sur "pause", on définit deux actions
	$(obj).siblings().find(".pause").toggle(

		// On change l'image de fond du bouton via la classe "play"
		function(){
			$(this).removeClass("pause").addClass("play");

			// On supprime l'intervalle
			clearInterval(inter);

			// On positionne le booléen à true
			pause = true;
		},
		function(){

			// On remet l'image originale
			$(this).removeClass("play").addClass("pause");

			// On relance le diaporama dans le sens où il était
			inter = setInterval(function(){ (sens == "right")?nextElt(options):prevElt(options)}, (options.delay*1000));
			pause = false;
		}
	);
}

Ensuite, nous allons développer la fonction qui permet de passer à l’image suivante:

function nextElt(options)
{
	// On cache de manière progressive l'image active
	$(obj).find("li.active").fadeOut(options.animationSpeed);

	// Si l'image active courante n'est pas la dernière image de la liste
	if(!$(obj).find("li.active").is(":last-child"))
	{
		// Alors on cherche l'image suivante (".next()"), on lui ajoute la class "active",
		// et on retire cette classe à l'image précedente (l'ancienne image active)
		$(obj).find("li.active").next().addClass("active").prev().removeClass("active");

		// On affiche la nouvelle image active progressivement
		$(obj).find("li.active").fadeIn(options.animationSpeed);
	}
	// L'image est la dernière de la liste
	else
	{
		// On fait la même chose mais en prenant la première image de la liste via le sélecteur "first-child"
		$(obj).find("li:first-child").addClass("active").fadeIn(options.animationSpeed);
		$(obj).find("li:last-child").removeClass("active");
	}
}

Script final

Et voilà, nous avons à présent tous les éléments dont nous avons besoin pour que le diaporama fonctionne.

Voici le script final diaporama.js :

(function($){
	$.fn.diaporama = function(options) {

		var defaults = {
			delay: 3,
			animationSpeed: "normal",
			controls:true
		};

		var options = $.extend(defaults, options);

		this.each(function(){

			var obj = $(this);

			if($(obj).find("li").length > 1){
				var inter = setInterval(function(){nextElt(options)}, (options.delay*1000));
				var sens = "right";
				var pause = false;

				$(obj).find("li").hide();
				$(obj).find("li:first-child").addClass("active").fadeIn(options.animationSpeed);

				// Controls

				if(options.controls)
				{
					$(obj).after("<div class='diaporama_controls'><div class='btns'><a href='#' class='prev'>Prec.</a> <a href='#' class='pause'>Pause</a> <a href='#' class='next'>Suiv.</a></div></div>");

					$(obj).siblings().find(".prev").click(function(){
						clearInterval(inter);
						prevElt(options);
						if(!pause)
							inter = setInterval(function(){prevElt(options)}, (options.delay*1000));
						sens = "left";
					});

					$(obj).siblings().find(".next").click(function(){
						clearInterval(inter);
						nextElt(options);
						if(!pause)
							inter = setInterval(function(){nextElt(options)}, (options.delay*1000));
						sens = "right";
					});

					$(obj).siblings().find(".pause").toggle(
						function(){
							$(this).removeClass("pause").addClass("play");
							clearInterval(inter);
							pause = true;
						},
						function(){
							$(this).removeClass("play").addClass("pause");
							inter = setInterval(function(){ (sens == "right")?nextElt(options):prevElt(options)}, (options.delay*1000));
							pause = false;
						}
					);
				}

				// Affiche l'élément suivant

				function nextElt(options)
				{
					$(obj).find("li.active").fadeOut(options.animationSpeed);

					if(!$(obj).find("li.active").is(":last-child"))
					{
						$(obj).find("li.active").next().addClass("active").prev().removeClass("active");
						$(obj).find("li.active").fadeIn(options.animationSpeed);

					}
					else
					{
						$(obj).find("li:first-child").addClass("active").fadeIn(options.animationSpeed);
						$(obj).find("li:last-child").removeClass("active");
					}
				}

				// Affiche l'élément précédent

				function prevElt(options)
				{
					$(obj).find("li.active").fadeOut(options.animationSpeed);

					if(!$(obj).find("li.active").is(":first-child"))
					{
						$(obj).find("li.active").prev().addClass("active").next().removeClass("active");
						$(obj).find("li.active").fadeIn(options.animationSpeed);

					}
					else
					{
						$(obj).find("li:last-child").addClass("active").fadeIn(options.animationSpeed);
						$(obj).find("li:first-child").removeClass("active");
					}
				}
			}
		});

		return this;
	};
})(jQuery);

Téléchargements et Démo

La démo est disponible ici.

Les fichiers sources : télécharger les fichiers sources de l’example.

119 commentaires

1 2 3 6
  1. lucas

    Bonjour,
    merci pour le partage de vos connaissances et de votre travail.
    Je suis en ce moment sur le développement d’un diaporama d’articles sous SPIP et votre plugin bien détaillé me semble adapté à ce que je recherche.

    Une petite question : peut-on ne pas précharger les images (en fait je désire incorporer des éléments video flv par exemple, ou flash swf) afin qu’au changement d’affichage de diapositive la lecture du fichier avi démarre, comme si on venait d’ouvrir la page html contenant ce fichier ?

    Merci pour votre aide.

    Cordialement

    Pascal

  2. Guillaume

    @lucas: Merci de votre intérêt pour mon tutoriel.

    Dans votre cas, il vous faudrait utiliser la librairie Swf Object pour la lecture de flash/flv, modifier en conséquence le plugin pour qu’il puisse detecter le type d’élément (image ou flash) et ainsi pouvoir lancer l’animation automatiquement lorsque l’élément actif est celui où est le flash (via swf object).

    Tout cela est donc bien possible ! Bon courage pour vos développements.

  3. Malou

    Bonjour, et merci beaucoup pour ce Tutoriel.

    Est-il possible (ou plutôt devrais-je dire facile) d’inclure une légende du type 1/6, 2/6, etc.
    Autre chose, où définit-on, le placement des flèches (je voudrai plutôt les placer en haut des images)?

    Merci d’avance

  4. Guillaume

    @Malou: Il est très facile d’inclure une légende, il te suffit d’ajouter le texte de la légende dans le « li » qui contient l’image. Elle sera affichée automatiquement lorsque le « li » sera affiché.

    Les flèches sont par défaut affichées après l’image. Pour changer l’emplacement, il te suffit de changer dans cette ligne:

    $(obj).after("Prec. Pause Suiv.");

    le « .after() » par « .before() » (http://docs.jquery.com/Manipulation/before#content)

    Et le tour est joué 😉

  5. Malou

    Merci mille fois pour cette réponse très claire et très rapide!
    M.

  6. Sofien

    Bonjour,
    j’aimerais savoir si il est possible de réinitialiser le diaporama à la suite d’un changement de contenu ?
    Merci !

  7. Guillaume

    @ Sofien: Oui pas de problème, il te suffit de rappeler la méthode « diaporama() » et cela prendra en compte les nouvelles modifications.

  8. Alex

    Bonjour Guillaume et merci pour ce tutoriel très bien fait et très bien expliqué.
    En fait, j’aimerais savoir s’il était possible de changer les boutons flèches afin de les adapter à ma charte graphique.

    Merci beaucoup !

    Alex

  9. Guillaume

    @Alex: Tout est dans le css 😉 Les boutons flèches sont des Sprites CSS, il te suffit donc de créer tes propres images !

  10. carine

    Bonjour,

    Merci pour ce tutoriel pour utile !

    Tout marche très bien, sauf le « next » et « previous ». Lorsque je clique dessus, la page remonte tout en haut comme après un rechargement de page (mon diaporama se trouve bas de page).

    Merci pour votre réponse

  11. Guillaume

    @ Carine : Oui effectivement, il manque un « return false » dans les fonctions de click :

    $(obj).siblings().find(« .next »).click(function(){
    clearInterval(inter);
    nextElt(options);
    if(!pause)
    inter = setInterval(function(){nextElt(options)}, (options.delay*1000));

    sens = « right »;

    return false; // Empêche l’action du lien (l’encre # remonte en haut de la page)

    });

    Merci pour la remarque 😉

  12. JP

    Super tutoriel, très bien fait et expliqué…

    Juste pour pinailler, j’aurais nommé le fichier SCRIPT.JS de manière plus significative, du genre DIAPORAMA_PARAMS.JS

  13. janguifett

    Super ce tutoriel.

    Vraiment ce blog est très intéressant !

    Juste une petite chose :
    Le fichier .zip a télécharger est de la forme : jquery.diaporama.zip et winrar ne reconnaissait pas l’extension à cause du point entre jquery et diaporama…

  14. mb

    Superbe de clarté et de simplicité: bravo.

    Etant novice, comment peut on mettre indifféremment des images verticales et horizontales et faire en sorte qu’elles soient centrées ?
    (j’arrive a les avoir toutes de la même hauteur, mais…)

    merci

  15. philippeW

    bonjour Guillaume,
    je viens de découvrir votre tutoriel qui est vraiment bien. Mon seul soucis c’est, qu’une fois installé dans un tableau html, les flèches de navigations ne s’affichent pas. Elles restent néanmoins actives au survol de la souris.
    Avez-vous une solution ?
    En vous remerciant

  16. Guillaume

    Bonjour Guillaume,

    C’est un très bon tutoriel, chaque ligne est clairement expliqué, un vrai plaisir à lire.

    Concernant le résultat final, et pour une raison que j’ignore, le fadeIn fadeOut fonctionne très bien sur Firefox, mais pas sur ma version de Chrome, si tu as une explication, je serais très intéressé de la connaître.
    J’espère avoir très prochainement le plaisir de lire d’autres tutoriels sur ton blog.

    À très bientôt,

    Guillaume

  17. vero

    Bonjour,

    Merci pour le script. C’est exactement ce que je cherchais.
    Maintenant que ça fonctionne j’aimerais que les boutons du controler n’apparaissent qu’en survolant le diaporama.
    J’imagine que c’est possible mais comme je ne m’y connais pas en javascript… je préfère demander.

    Encore félicitation !

  18. Xavier

    Super, juste ce dont j’avais besoin. Simple, clair et efficace.
    Merci

  19. Phil

    Merci pour ce superbe tutoriel !

    Juste pour faire le perfectionniste, j’ai remarqué qu’aléatoirement le script engendre une erreur sur la console d’erreurs de mozilla :

     » Erreur d’analyse de la valeur pour « opacity ». Déclaration abandonnée.  »

    Rien de bien méchant cependant….

  20. orl

    bravo, bravo, bravo
    j’ai pu utiliser ce tutoriel
    exactement ce que je cherchais depuis des lustres
    juste une petite question, (j’ai cherché et pas trouvé tout seul)
    comment faire démarrer le diaporama en mode « pause » par defaut, et laisser a l’utilisateur le choix de le démarrer ou de changer les photos a sa guise ..?
    l’inverse de ce qui ce passe dans ce script

    merci encore pour cette perle

1 2 3 6

Laisser une réponse à Malou


Post shadow