https://github.com/emmanuelbeziat/jquery-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).
https://github.com/emmanuelbeziat/jquery-scrolloffset

anchors javascript jquery scroll

Last synced: about 1 month ago
JSON representation

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).

• Host: GitHub
• URL: https://github.com/emmanuelbeziat/jquery-scrolloffset
• Owner: EmmanuelBeziat
• License: gpl-2.0
• Created: 2014-04-30T04:47:01.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-05T16:56:32.000Z (over 7 years ago)
• Last Synced: 2024-04-15T02:06:58.539Z (8 months ago)
• Topics: anchors, javascript, jquery, scroll
• Language: JavaScript
• Size: 127 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![version](https://img.shields.io/badge/version-2.1.1-orange.svg?style=flat-square) ![madewith](https://img.shields.io/badge/made%20with-jquery-brightgreen.svg?style=flat-square)

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

```bash

$ 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.

```javascript

$('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)