menuMDUIDocs
color_lens
mdui 2 est arrivé, basé sur Material Design 3 et les Web Components. Consultez la documentation de mdui 2 ici.

Headroom

Le plugin Headroom peut réagir au défilement de la page, par exemple en faisant disparaître la Top App Bar lorsque la page défile vers le bas, et en l'affichant lorsque la page défile vers le haut.

Les fonctions d'auto-masquage de la Top App Bar et d'auto-masquage de la Navigation inférieure présentées précédemment sont implémentées à l'aide de ce plugin.

Utilisation

  1. Appel via des attributs personnalisés (si le composant est généré dynamiquement, vous devez appeler mdui.mutation() pour l'initialiser)
  2. Appel via JavaScript

Utilisation

Appel via attributs

Cette méthode ne nécessite pas d'écrire de JavaScript. Il suffit d'ajouter l'attribut mdui-headroom="options" à l'élément pour activer le plugin.

Si le composant est généré dynamiquement, il faut appeler mdui.mutation() pour l'initialiser.

<div mdui-headroom style="position: fixed; top: 0; left: 0; right: 0;"></div>
demo

Appel via JavaScript

Instancier le plugin :

// selector est un sélecteur CSS ou un élément DOM
// options sont les paramètres du plugin, voir la liste des paramètres ci-dessous
var inst = new mdui.Headroom(selector, options);
demo

Paramètre

NomTypeDéfautDescription
toleranceint | Object5

À quelle distance de défilement déclencher la disparition de l'élément.

Si la valeur est un nombre, la distance de déclenchement est identique pour le défilement vers le haut et vers le bas.

Peut aussi être un objet, spécifiant respectivement les distances de déclenchement pour le défilement vers le haut et vers le bas. Exemple { down: 10, up: 5 }.

offsetint0À quelle distance depuis le haut de la page le défilement doit-il commencer à masquer l'élément.
initialClassstringmdui-headroomClasse CSS ajoutée à l'élément après l'initialisation du plugin.
pinnedClassstringmdui-headroom-pinned-topClasse CSS ajoutée après fixation de l'élément.
unpinnedClassstringmdui-headroom-unpinned-topClasse CSS ajoutée après suppression de la fixation.

Méthode

Nom de méthodeDescription
pin()Rendre l'élément fixe.
unpin()Masquer l'élément.
enable()Activer le plugin Headroom.
disable()Désactiver le plugin Headroom.
getState()Obtenir l'état actuel de l'élément. Il existe quatre états au total (pinning, pinned, unpinning, unpinned).

Événement

Nom de l'événementDescriptionParamètres
pin.mdui.headroomDéclenché au début de la fixation.event._detail.inst : instance
pinned.mdui.headroomDéclenché à la fin de la fixation.
unpin.mdui.headroomDéclenché au début du masquage.
unpinned.mdui.headroomDéclenché après le masquage.