menuMDUIDocs
color_lens
O novo mdui 2, baseado em Material Design 3 e Web Components, já foi lançado, veja a documentação do mdui 2.

Headroom

O plugin Headroom permite reagir ao rolamento da página. Por exemplo, ao rolar para baixo, a barra de aplicativo desaparece; ao rolar para cima, ela reaparece.

As funcionalidades de ocultar automaticamente a barra de aplicativo e ocultar automaticamente a barra de navegação inferior mencionadas anteriormente são implementadas usando este plugin.

Como usar

  1. Chamada via atributos personalizados (se o componente for gerado dinamicamente, é necessário chamar mdui.mutation() para inicialização)
  2. Chamar via JavaScript

Como usar

Chamar via atributos personalizados

Neste modo, não é necessário escrever código JavaScript. Basta adicionar o atributo mdui-headroom="options" ao elemento para ativar o plugin.

Se o componente for gerado dinamicamente, é necessário chamar mdui.mutation() para inicialização.

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

Chamar via JavaScript

Instanciar o plugin:

// selector é um seletor CSS ou um elemento DOM
// options são os parâmetros do plugin, veja a lista de parâmetros abaixo
var inst = new mdui.Headroom(selector, options);
demo

Parâmetro

Nome do parâmetroTipoValor padrãoDescrição
toleranceint | Object5

A distância de rolagem após a qual o elemento deve ser ocultado.

Se o valor for um número, indica que a distância de ativação para rolagem para cima e para baixo é a mesma.

Também pode ser um objeto especificando as distâncias de ativação para cima e para baixo separadamente. Ex: { down: 10, up: 5 }.

offsetint0A distância do topo da página na qual o elemento começa a ser ocultado ao rolar.
initialClassstringmdui-headroomClasse CSS adicionada ao elemento após a inicialização do plugin.
pinnedClassstringmdui-headroom-pinned-topClasse CSS adicionada após fixar o elemento.
unpinnedClassstringmdui-headroom-unpinned-topClasse CSS adicionada após desafixar o elemento.

Método

Nome do métodoDescrição
pin()Torna o elemento fixo.
unpin()Oculta o elemento.
enable()Habilita o plugin headroom.
disable()Desabilita o plugin headroom.
getState()Obtém o estado atual do elemento. Existem quatro estados (pinning, pinned, unpinning, unpinned).

Evento

Nome do eventoDescriçãoParâmetros
pin.mdui.headroomDisparado quando começa a fixar.event._detail.inst: instância
pinned.mdui.headroomDisparado ao terminar de fixar.
unpin.mdui.headroomDisparado quando começa a ocultar.
unpinned.mdui.headroomDisparado após ocultar.