menuMDUIDocs
color_lens
Zcela nové mdui 2 založené na Material Design 3 a Web Components bylo vydáno, přejděte na dokumentaci mdui 2.

Headroom

Zásuvný modul Headroom lze aktivovat při posunování stránky, například když se stránka posune dolů, horní aplikační lišta zmizí; když se stránka posune nahoru, horní aplikační lišta se objeví.

Funkce automatického skrytí horní aplikační lišty a automatického skrytí spodní navigační lišty zmíněné dříve jsou implementovány pomocí tohoto zásuvného modulu.

Způsob volání

  1. Volání prostřednictvím vlastních atributů (pokud je komponenta dynamicky generována, je třeba zavolat mdui.mutation() k inicializaci)
  2. Volání přes JavaScript

Způsob volání

Volání přes atributy

Tímto způsobem není třeba psát kód v JavaScriptu. Stačí přidat atribut mdui-headroom="options" do prvku a zásuvný modul se aktivuje.

Pokud je komponenta dynamicky generována, je třeba zavolat mdui.mutation() k inicializaci.

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

Volání přes JavaScript

Instanciování zásuvného modulu:

// selector je CSS selektor nebo DOM prvek
// options jsou parametry zásuvného modulu, viz seznam parametrů níže
var inst = new mdui.Headroom(selector, options);
demo

Parametr

Název parametruTypVýchozí hodnotaPopis
toleranceint | Object5

Kolik pixelů se má stránka posunout, aby se prvek skryl.

Pokud je hodnota parametru číslo, znamená to, že vzdálenost posunování nahoru a dolů je stejná.

Může to být také objekt, který určuje vzdálenost posunování nahoru a dolů zvlášť. Například { down: 10, up: 5 }.

offsetint0Kolik pixelů od horní části stránky se má prvek začít skrývat při posunování.
initialClassstringmdui-headroomCSS třída přidaná do prvku po inicializaci zásuvného modulu.
pinnedClassstringmdui-headroom-pinned-topCSS třída přidaná po upevnění prvku.
unpinnedClassstringmdui-headroom-unpinned-topCSS třída přidaná po zrušení upevnění.

Metoda

Název metodyPopis
pin()Upevní prvek.
unpin()Skryje prvek.
enable()Aktivuje zásuvný modul headroom.
disable()Deaktivuje zásuvný modul headroom.
getState()Získá aktuální stav prvku. Obsahuje čtyři stavy (pinning, pinned, unpinning, unpinned).

Událost

Název událostiPopisParametry
pin.mdui.headroomUdálost bude spuštěna na začátku připnutí.event._detail.inst: instance
pinned.mdui.headroomUdálost bude spuštěna po připnutí.
unpin.mdui.headroomUdálost bude spuštěna na začátku skrytí.
unpinned.mdui.headroomUdálost bude spuštěna po skrytí.