menuMDUIDocs
color_lens
Nowy mdui 2 oparty na Material Design 3 i Web Components jest już dostępny, przejdź do dokumentacji mdui 2.

Headroom

Wtyczka Headroom reaguje na przewijanie strony, na przykład pasek aplikacji znika podczas przewijania w dół i pojawia się podczas przewijania w górę.

Funkcje automatycznego ukrywania paska aplikacji i automatycznego ukrywania dolnego paska nawigacji podczas przewijania, o których wspomniano wcześniej, są realizowane za pomocą tej wtyczki.

Sposób użycia

  1. Wywołanie przez atrybuty niestandardowe (jeśli komponent jest generowany dynamicznie, należy wywołać mdui.mutation() w celu inicjalizacji)
  2. Wywołanie przez JavaScript

Sposób użycia

Wywołanie przez atrybuty

W ten sposób nie trzeba pisać kodu JavaScript. Wystarczy dodać atrybut mdui-headroom="options" do elementu, aby aktywować wtyczkę.

Jeśli komponent jest generowany dynamicznie, należy wywołać mdui.mutation() w celu inicjalizacji.

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

Wywołanie przez JavaScript

Instancjonowanie wtyczki:

// selector to selektor CSS lub element DOM
// options to parametry wtyczki, patrz lista parametrów poniżej
var inst = new mdui.Headroom(selector, options);
demo

Parametr

Nazwa parametruTypWartość domyślnaOpis
toleranceint | Object5

Odległość przewijania, po której następuje ukrycie elementu.

Jeśli wartość parametru jest liczbą, oznacza to, że odległość wyzwalająca przewijanie w górę i w dół jest taka sama.

Może to być również obiekt określający odpowiednio odległości wyzwalające przewijanie w górę i w dół. Na przykład { down: 10, up: 5 }.

offsetint0Odległość od góry strony, po której przewijanie zaczyna ukrywać element.
initialClassstringmdui-headroomKlasa CSS dodawana do elementu po inicjalizacji wtyczki.
pinnedClassstringmdui-headroom-pinned-topKlasa CSS dodawana po przypięciu elementu.
unpinnedClassstringmdui-headroom-unpinned-topKlasa CSS dodawana po odpięciu elementu.

Metoda

Nazwa metodyOpis
pin()Powoduje przypięcie elementu.
unpin()Powoduje ukrycie elementu.
enable()Włącza wtyczkę headroom.
disable()Wyłącza wtyczkę headroom.
getState()Pobiera aktualny stan elementu. Obejmuje cztery stany (pinning, pinned, unpinning, unpinned).

Zdarzenie

Nazwa zdarzeniaOpisParametry
pin.mdui.headroomWyzwalane po rozpoczęciu przypinania.event._detail.inst: Instancja
pinned.mdui.headroomWyzwalane po zakończeniu przypinania.
unpin.mdui.headroomWyzwalane po rozpoczęciu ukrywania.
unpinned.mdui.headroomWyzwalane po ukryciu.