hiding-header

Toggles header visibility on scroll.

0.2.0
Source
npm

Version published: 4 years ago

Weekly downloads: 56; decreased by-39.78%

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

Hiding Header

Toggles header visibility on scroll. Demo.

UI example

Installation

npm install hiding-header

How to use

HTML:

<!-- … -->
<body>
	<div class="hidingHeader" id="hidingHeader">
		<div class="hidingHeader-in">
			<!-- Your header -->
		</div>
	</div>
	<!-- … -->
</body>
<!-- … -->

CSS:

.hidingHeader {
	position: relative;
	--hidingHeader-height: auto;
	--hidingHeader-bounds-height: auto;
	--hidingHeader-animation-offset: 0px;
	z-index: 10;
	height: var(--hidingHeader-bounds-height);
	margin-bottom: calc(
		var(--hidingHeader-height) - var(--hidingHeader-bounds-height)
	);
	pointer-events: none;
}

.hidingHeader-in {
	position: relative;
	position: sticky;
	top: 0;
	pointer-events: auto;
	transition: transform 0.2s;
	transform: translateY(var(--hidingHeader-animation-offset));
}

JavaScript:

import { hidingHeader } from 'hiding-header'

const container = document.querySelector('#hidingHeader')
hidingHeader(container)

import { hidingHeader } from 'hiding-header'

const container = document.querySelector('#hidingHeader')
const instance = hidingHeader(container)

// …
instance.pause() // Pauses scroll listener
// …
instance.isPaused() // Check if scroll listener is paused
// …
instance.run() // Reactivates scroll listener
// …

// …
instance.reveal() // Reveals header if hidden
// …
instance.hide() // Hides header if visible
// …

React component

For more information see hiding-header-react.

Keywords

FAQs

What is hiding-header?

Is hiding-header popular?

Is hiding-header well maintained?

Package last updated on 30 Dec 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install