Create an affixing header that behaves normally as a user navigates down a page, but reveals itself naturally when a user scrolls or drags upwards. Inspired by iOS Safari, Medium, and others. See an example implementation to see what it’s about. Works on desktop and mobile browsers.
The module itself is available in a wide range of flavors:
- As a CommonJS (Browserify-friendly) module (via UMD):
- As an AMD (RequireJS-friendly) module (also via UMD):
- As the
window.affixingHeaderglobal with dependencies bundled in:
dist/affixing-header-bundled.js, or minified as
- As an ES6/ES2015 module (identified by
jsnext:mainin package.json), compatible with ES6-compatible module loaders like SystemJS or compilers like Babel:
Exports a single function via
require('affixing-header') if being used with a CommonJS or AMD module loader, or else exposes the function as a global named
affixingHeader( element )
The DOM element to which the affixing behavior should be attached. Must be a single Element (e.g., the result of
document.getElementById), not a
This package uses onscrolling, a requestAnimationFrame-based, performant, mobile-friendly scroll event handler, to listen for page scrolls, but has no other dependencies.
The scroll handling uses
requestAnimationFrame, which is only available in IE10+. For older browsers, your header won’t affix to the top of the page when you scroll up, but you shouldn’t see any other issues (yay progressive enhancement). To add full support for older browsers, just include a requestAnimationFrame polyfill.