menuMDUIDocs
color_lens
El nuevo mdui 2 basado en Material Design 3 y Web Components ya está disponible. Consulta la documentación de mdui 2 ahora.

Headroom

El complemento Headroom puede responder al desplazamiento de la página; por ejemplo, cuando la página se desplaza hacia abajo, la barra de aplicaciones desaparece, y cuando se desplaza hacia arriba, vuelve a aparecer.

La función de ocultar automáticamente la barra de aplicaciones y la de ocultar automáticamente la barra de navegación inferior que se presentó anteriormente se implementa con este complemento.

Modo de uso

  1. Se llama mediante atributos personalizados (si el componente se genera dinámicamente, debes llamar a mdui.mutation() para inicializarlo).
  2. Llamada vía JavaScript

Modo de uso

Llamada vía atributos

Con este método no necesitas escribir JavaScript. Solo tienes que añadir el atributo mdui-headroom="options" al elemento para activar el complemento.

Si el componente se genera dinámicamente, debes llamar a mdui.mutation() para inicializarlo.

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

Llamada vía JavaScript

Instanciar el complemento:

// selector es un selector CSS o un elemento DOM
// options son los parámetros del complemento; consulta la lista de parámetros que aparece a continuación
var inst = new mdui.Headroom(selector, options);
demo

Parámetro

NombreTipoValor por defectoDescripción
toleranceint | Object5

Distancia de desplazamiento tras la cual se desencadena el ocultamiento del elemento.

Si el valor es un número, la distancia de activación es la misma tanto para el desplazamiento hacia arriba como hacia abajo.

También puede ser un objeto que especifique la distancia de activación para el desplazamiento hacia arriba y hacia abajo por separado. Por ejemplo, { down: 10, up: 5 }.

offsetint0Distancia desde la parte superior de la página a partir de la cual comienza a ocultarse el elemento al desplazarse.
initialClassstringmdui-headroomClase CSS añadida al elemento tras inicializar el complemento.
pinnedClassstringmdui-headroom-pinned-topClase CSS añadida cuando el elemento queda fijado.
unpinnedClassstringmdui-headroom-unpinned-topClase CSS añadida tras dejar de fijar el elemento.

Método

Nombre del métodoDescripción
pin()Fijar el elemento.
unpin()Ocultar el elemento.
enable()Habilitar el complemento headroom.
disable()Deshabilitar el complemento headroom.
getState()Obtener el estado actual del elemento. Hay cuatro estados en total (pinning, pinned, unpinning y unpinned).

Evento

Nombre del eventoDescripciónParámetros
pin.mdui.headroomSe dispara al comenzar a fijar.event._detail.inst: instancia
pinned.mdui.headroomSe dispara cuando termina de fijarse.
unpin.mdui.headroomSe dispara al comenzar a ocultarse.
unpinned.mdui.headroomSe dispara después de ocultarse.