JavaScript / jQuery 🏖️ Le Smooth Scrolling

Dans cet article, nous voyons comment utiliser le Smooth Scrolling, aussi appelé défilement doux ou fluide, en JavaScript et jQuery.

Ce procédé permet d'appliquer une animation au scroll et de ralentir le défilement vers un élément ciblé par une ancre au click sur un lien, par un sélecteur jQuery ou vers le haut de la page.

Cette animation pourtant simple apporte aux utilisateurs des sites qui l'utilisent un confort de lecture supplémentaire. En effet, le déplacement à l'intérieur du site par le biais de liens hypertexte internes se faisant de manière visible et compréhensible, l'utilisateur ne se retrouve plus "téléporté", mais est capable de se retrouver instinctivement. Il sait s’il arrive sur une partie qui précède ou devance le lien sur lequel il a cliqué, ainsi que la distance qui le sépare de ce dernier.

Dans les différents cas d'utilisations présentés ici, l'effet de Smooth Scrolling est paramétré pour s'effectuer sur 1500 millisecondes. Il est possible d'allonger ou de raccourcir ce temps d'exécution en modifiant cette valeur.

Défilement fluide sur les liens HTML vers les ancres avec jQuery

Pour rappel, les liens hypertextes vers des ancres ont la forme <a href="#my-id">Link to anchor</a> et pointent vers des éléments HTML identifiés par leurs ID, par exemple <h2 id="my-id">My destination</h2>. Une fois ajouté sur votre site, le code ci-dessous appliquera cet effet de Smooth Scroll automatiquement au clic sur un lien pointant vers une ancre de la page en cours.

$(function() {
    /**
    * Smooth scrolling to page anchor on click
    **/
    $("a[href*='#']:not([href='#'])").click(function() {
        if (
            location.hostname == this.hostname
            && this.pathname.replace(/^\//,"") == location.pathname.replace(/^\//,"")
        ) {
            var anchor = $(this.hash);
            anchor = anchor.length ? anchor : $("[name=" + this.hash.slice(1) +"]");
            if ( anchor.length ) {
                $("html, body").animate( { scrollTop: anchor.offset().top }, 1500);
            }
        }
    });
});

Défilement fluide vers un élément HTML avec jQuery

Cette fonction, qui prend un sélecteur jQuery en paramètre, permet d'effectuer un déplacement fluide vers un élément HTML ciblé. Dans le code ci-dessous, je vous présente une fonction JavaScript scrollTo( target ) qui prend en paramètre un élément jQuery et applique l'effet Smooth Scroll vers ce dernier. L'exemple d'utilisation de la fonction applique cet effet sur l'élément ayant l'ID my-id.

$(function() {
    /**
    * Smooth scrolling to a specific element 
    **/
    function scrollTo( target ) {
        if( target.length ) {
            $("html, body").stop().animate( { scrollTop: target.offset().top }, 1500);
        }
    }

    // exemple
    scrollTo( $("#mon-id") );
});

Défilement fluide vers le sommet de la page avec jQuery

Afin de faire le tour du sujet, je vous propose de finir sur un bout de code JavaScript / jQuery qui permet de faire un défilement fluide vers le sommet de la page.

$(function() {
	 /**
	 * Smooth scrolling to the top of page !
	 **/
	 $("html, body").animate({scrollTop : 0}, 1500);
});