menuMDUIDocs
color_lens
Новый mdui 2 на базе Material Design 3 и Web Components уже здесь. Перейти к документации mdui 2.

Headroom

Плагин Headroom позволяет реагировать на прокрутку страницы: например, панель приложения исчезает при прокрутке вниз и появляется при прокрутке вверх.

Описанные ранее функции автоматического скрытия панели приложения и автоматического скрытия нижней панели навигации при прокрутке реализованы с помощью этого плагина.

Использование

  1. Вызов через пользовательские атрибуты (если компонент создается динамически, необходимо вызвать mdui.mutation() для инициализации)
  2. Вызов через JavaScript

Использование

Вызов через атрибуты

При использовании этого способа не нужно писать JavaScript-код. Просто добавьте атрибут mdui-headroom="options" к элементу, чтобы активировать плагин.

Если компонент создается динамически, необходимо вызвать mdui.mutation() для инициализации.

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

Вызов через JavaScript

Инициализация плагина:

// selector — это CSS-селектор или DOM-элемент
// options — параметры плагина, см. список параметров ниже
var inst = new mdui.Headroom(selector, options);
demo

Параметр

Имя параметраТипПо умолчаниюОписание
toleranceint | Object5

Расстояние прокрутки, после которого элемент начинает скрываться.

Если значением является число, оно указывает на одинаковое расстояние срабатывания для прокрутки вверх и вниз.

Также может быть объектом, задающим разные расстояния срабатывания для прокрутки вверх и вниз. Например, { down: 10, up: 5 }.

offsetint0Минимальное расстояние от верха страницы, при котором элемент начинает скрываться при прокрутке.
initialClassstringmdui-headroomCSS-класс, добавляемый к элементу после инициализации плагина.
pinnedClassstringmdui-headroom-pinned-topCSS-класс, добавляемый после фиксации элемента.
unpinnedClassstringmdui-headroom-unpinned-topCSS-класс, добавляемый после отмены фиксации.

Метод

Имя методаОписание
pin()Зафиксировать элемент.
unpin()Скрыть элемент.
enable()Включить плагин headroom.
disable()Отключить плагин headroom.
getState()Получить текущее состояние элемента. Всего существует четыре состояния (pinning, pinned, unpinning, unpinned).

Событие

Имя событияОписаниеПараметры
pin.mdui.headroomСрабатывает при начале фиксации.event._detail.inst: экземпляр
pinned.mdui.headroomСрабатывает после завершения фиксации.
unpin.mdui.headroomСрабатывает при начале скрытия.
unpinned.mdui.headroomСрабатывает после скрытия.