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.

Ces articles peuvent aussi vous intéresser :

119 commentaires

1 2 3 4 … 6
  1. Guillaume
    22 avril 2010

    @orl: Pour démarrer le diaporama en mode pause par défaut, il faut commenter cette ligne:

    // setInterval(function(){nextElt(options)}, (options.delay*1000));

    en début de script, et changer la classe du bouton pour afficher le picto « pause ».

    Ensuite le comportement suivra. Tu dois pouvoir t’en sortir comme ça 😉

    Répondre
  2. Felicie
    22 avril 2010

    Bonjour, bravo, c’est très bien vulgarisé pour les novices
    En revanche, je souhaiterai remplacer les boutons de contrôle par du texte.
    Pouvez-vous m’aider ?
    Merci

    Répondre
  3. Guillaume
    23 avril 2010

    Pour remplacer les boutons par du texte, il suffit de modifier le fichier css et enlever les propriétés suivantes sur les boutons :
    – background
    – text-indent
    – display

    Et hop comme par magie, le texte apparait !

    Répondre
  4. webmasternic
    30 mai 2010

    Un grand merci pour cet excellent tutoriel très détaillé. Il m’a permis de réaliser un diaporama sur ma page d’accueil reprenant mes photographies publiées sur mes pages. L’atout de ce diaporama est de pouvoir ajouter un lien sur l’image mais également d’ajouter un descriptif de l’image – élément essentiel pour un meilleur référencement des images.

    Répondre
  5. soso
    28 juin 2010

    bonjour,
    merci pour ce tutoriel cepandant les boutons precedent pause et suivant s affiche tres bien sous firefox mais pas sous internet explorer. avez vous une solution a ce probleme??
    merci

    Répondre
  6. Gui
    28 juin 2010

    @ Soso : Effectivement, il y a un petit problème avec IE (6 & 7) dû à une mauvaise interprétation du style « inline-block + text-indent ». Je l’ai corrigé en ajoutant un espace « &nbsp; » dans le div class=’ btns’ et hop ça remarche sous IE !

    Je l’ai mis à jour dans la demo et le zip.

    Merci pour la remarque 😉

    Répondre
  7. Bat
    29 juin 2010

    Bonjour,

    La page d’accueil de mon site ( http://www.lp-jard.fr/spip ) contient actuellement un diaporama en Flash qui fonctionne correctement.

    Cependant, pour des raisons d’accessibilité, je voudrais utiliser le diaporama présenté ici mais je voulais savoir si il était possible de charger les images une par une dans la page ??

    Merci

    Répondre
  8. Vic
    30 juin 2010

    En un mot comme en cent : Excellent !

    Remarque : IE6 & 7 ne semblent toujours pas répercuter correctement la modif du 28/06.
    Ca marche pour ces navigateurs chez vous ?

    Répondre
  9. Gui
    30 juin 2010

    @ Vic Merci !

    Oui cela fonctionne chez moi sur IE 6 & 7, bien que vous me direz le png transparent n’est pas très zoli sur IE 6! Mais sur mon blog je me permets d’éliminer certaines contraintes 🙂

    Répondre
  10. prad
    6 juillet 2010

    Bonjour Guillaume,

    Est-il possible de gérer le nombre de boucle du diaporama?
    Par exemple, ne faire réaliser qu’un seul « tour », au lieu de tourner ad libitum.

    Merci pour tout,
    françois

    Répondre
  11. Gui
    6 juillet 2010

    @ Prad: Oui tu peux tout à fait envisager de rajouter un paramètre « boucles » dans le script par défaut à 0 (illimité) par exemple, et de vérifier dans les fonctions « next » et « prev » ce paramètre (est-il supérieur à 0 ?) et décrementer une autre variable en fonction et ne plus appeler la fonction next ou prev lorsque cette variable arrive 0. Le diaporama s’arrêtera alors.

    Il ne te reste plus qu’à essayer 😉

    Répondre
  12. alain
    7 juillet 2010

    Bonjour,

    D’abord merci pour ce diaporama vraiment utile.
    Je reviens juste sur le démarrage de la page en mode pause.
    J’ai modifié le script comme signalé et changer la classe.
    Ca fonctionne mais en cliquant sur lecture le diaporama ne redémarre pas. Il faut passer par la flèche suivant pour qu’il se lance ce qui n’est pas pratique.
    Comment faire pour le relancer en cliquant simplement sur la fleche lecture quand il est sur pause par défaut ?
    Merci pour ta réponse.
    alain

    Répondre
  13. iki
    19 juillet 2010

    Merci infiniment pour le temps passé à décortiquer ce script que du coup, ô miracle, j’ai compris ! 🙂
    Diaporama impeccable, simple et pratique, que demander de plus ?

    Bravo et merci à Guillaume 🙂

    Répondre
  14. Lau
    29 juillet 2010

    Bonjour,
    Tout d’abord, un grand merci pour ce diaporama très facile à mettre en place et efficace… sauf qu’en effectuant des tests sur plusieurs postes, je m’aperçois que les boutons de controle ne s’affichent pas pour tous. Y a-til un moyen d’y remedier (j’ai mis un espace comme la modif du 28 juin mais rien…).
    Help !

    Répondre
  15. Lau
    29 juillet 2010

    ReBonjour,

    Toujours un grand merci et bonne nouvelle, j’ai trouvé ! En fait, quand IE est en mode Affichage de compatibilité, les boutons de contrôle ne s’affichent pas…
    A bon entendeur !

    Répondre
  16. martinoche
    2 septembre 2010

    Bonjour, je vois que ca fait plus d’un an que ce forum est lancé, j’ose esperer qu’il est encore possible de poser une question, notamment sur la demande d’avoir des legendes ou commentaires qui varient, sous chaque photo. La solution préconisée, plus haut : before ou after ne permet pas helas de faire varier les contenus; J’ai donc essayé de rajouter soit des p soit des div soit tous simplement un br sous l’image avant le /li de cloture. mais visiblement, ca finit par planter le diapo !! peut on me dire svp a quoi c’est lié ou quel code il serait bon de rajouter si c’est possible. merci d’avance

    Répondre
  17. Yann LECHELON
    15 septembre 2010

    Bonjour,

    Avant tout chapeau.
    Clair, efficace, bien expliqué et complet. Merci

    Par contre j’aimerai que le diaporama ne se lance pas automatiquement.
    Est-ce possible
    Merci d’avance

    Répondre
  18. Gui
    15 septembre 2010

    Merci Yann !

    Je t’invite comme tous ceux qui ont apprécié ce plugin à consulter la nouvelle version !

    C’est ici : Accéder au tout nouveau diaporama JQuery !

    Répondre
  19. edw
    1 octobre 2010

    Bonjour,

    Je suis en train de finir mon site, et je dois dire qu’il ne manque plus qu’une chouette galerie comme celle que tu proposes 🙂

    la galerie est intégré pas de soucis, j’ai ajouter les « return false; »
    et je voulais commencer sur pauve, et a vraie dire même la supprimer.

    j’ai donc commencé par commenté :
    // setInterval(function(){nextElt(options)}, (options.delay*1000));
    mais du coup le menu ne s’affiche plus.

    J’ai ensuite commenté :
    var inter = // setInterval(function(){nextElt(options)}, (options.delay*1000));
    ça fonctionne, mais pour que les boutons next/prev fonctionnent, je suis obliger de lancer et repauser le diaporama..

    bref je n’arrive pas à être sur pause au chargement sans avoir de soucis.

    un petit coup d’main ?

    merci pour se super tuto ! je vais essayer de trouver de mon côté en attendant !

    Répondre
  20. Gui
    1 octobre 2010

    Je ne saurais te conseiller que d’adopter la nouvelle version du plugin que tu trouveras ici : jDiaporama, le nouveau diaporama JQuery

    Répondre
1 2 3 4 … 6

Laisser une réponse


Post shadow
←
→