Un simple plugin de défilement d'ancres en jQuery, avec la possibilité de définir un décalage vertical (offset), par exemple pour tenir compte d'une navbar fixe (ou simplement pour une raison cosmétique).
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
dist
src
.gitignore
LICENSE
README.md
bower.json
gulpfile.js
package.json

README.md

version madewith

ScrollOffset

Un simple plugin de défilement d'ancres en jQuery, avec la possibilité de définir un décalage vertical (offset), par exemple pour tenir compte d'une navbar fixe (ou simplement pour une raison cosmétique).


#Installation

Si vous utilisez Bower, vous pouvez l'installer directement

$ bower install jquery-scrolloffset

Sinon, il vous suffit de récupérer manuellement les fichiers sur github.

#Utilisation

Le principe est basé sur les ancres html. Appelez simplement la méthode scrollOffset() sur un objet jQuery, qui soit un lien html comportant une ancre.

$('a[href^="#"]').scrollOffset();

#Options

Option Valeur par défaut Valeurs possibles Description
offset 0 Nombre entier Définit la valeur (en pixels) du décalage vertical à appliquer.
duration 400 nombre ou valeurs clé de temps jquery (slow, fast) Gère le temps de l'animation de défilement vers l'ancre.
onComplete null fonction Permet d'appeler une fonction de votre choix à la fin du défilement

#Évolutions envisagées

  • Si l'élément correspondant à l'ancre n'est pas trouvé dans la page → Gérer (renvoyer au top)
  • Permettre d'appeler autre chose qu'un ID (choix du sélecteur)