menuMDUIDocs
color_lens
A Material Design 3 és Web Components alapú új mdui 2 már elérhető, tekintse meg az mdui 2 dokumentációját.

Headroom

A Headroom bővítmény képes reagálni az oldal görgetésére, például az alkalmazássáv eltűnik lefelé görgetéskor, és megjelenik felfelé görgetéskor.

Az alkalmazássáv automatikus elrejtése és az alsó navigációs sáv automatikus elrejtése görgetéskor – amiről korábban szó volt – ezzel a bővítménnyel valósul meg.

Használat

  1. Hívás egyéni attribútumokon keresztül (ha a komponens dinamikusan jön létre, az inicializáláshoz a mdui.mutation() hívása szükséges)
  2. JavaScript segítségével történő hívás

Használat

Hívás egyéni attribútumokkal

Ezzel a módszerrel nincs szükség JavaScript kód írására. Csak adja hozzá az mdui-headroom="options" attribútumot az elemhez a bővítmény aktiválásához.

Ha a komponens dinamikusan jön létre, az inicializáláshoz a mdui.mutation() hívása szükséges.

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

JavaScript segítségével történő hívás

Bővítmény példányosítása:

// A selector egy CSS választó vagy DOM elem
// Az options a bővítmény paraméterei, lásd az alábbi paraméterlistát
var inst = new mdui.Headroom(selector, options);
demo

Paraméter

Paraméter neveTípusAlapértelmezettLeírás
toleranceint | Object5

A görgetési távolság, amely után az elem elrejtése elindul.

Ha a paraméter értéke szám, az a felfelé és lefelé görgetésnél is ugyanazt a távolságot jelenti.

Objektum is lehet, amely külön meghatározza a felfelé és lefelé görgetés távolságát. Például: { down: 10, up: 5 }.

offsetint0Az oldal tetejétől számított távolság, amely után elindul az elrejtés görgetés közben.
initialClassstringmdui-headroomA bővítmény inicializálása után az elemhez adott CSS osztály.
pinnedClassstringmdui-headroom-pinned-topA rögzített (pin) állapotban hozzáadott CSS osztály.
unpinnedClassstringmdui-headroom-unpinned-topA rögzítés feloldása (unpin) után hozzáadott CSS osztály.

Metódus

Metódus neveLeírás
pin()Az elem rögzítése.
unpin()Az elem elrejtése.
enable()A headroom bővítmény engedélyezése.
disable()A headroom bővítmény letiltása.
getState()Az aktuális elem állapotának lekérése. Négy állapot létezik (pinning, pinned, unpinning, unpinned).

Esemény

Esemény neveLeírásParaméterek
pin.mdui.headroomA rögzítés kezdetekor aktiválódik.event._detail.inst: Példány
pinned.mdui.headroomA rögzítés befejezésekor aktiválódik.
unpin.mdui.headroomAz elrejtés kezdetekor aktiválódik.
unpinned.mdui.headroomAz elrejtés után aktiválódik.