@dawaltconley/header-basic
v0.6.1
Published
A simple, modular website header.
Downloads
51
Maintainers
dawaltconleyReadme
Basic Header
A simple, modular website header. Html, CSS, and JavaScript all loaded and included separately, and support various means of inclusion in a project.
Contents
The base module expose server-side functions for building the header html.
import { generateHtml, eleventy } from '@dawaltconley/header-basic';Browser-only code can be imported from the browser submodule, or directly from the relevant js submodules.
import makeHeader, { FixedHeader, CollapsibleMenu } from '@dawaltconley/header-basic/browser';
// or...
import makeHeader from '@dawaltconley/header-basic/js/constructor';
import FixedHeader from '@dawaltconley/header-basic/js/fixed-header';
import CollapsibleMenu from '@dawaltconley/header-basic/js/collapsible-menu';Usage
HTML
import { generateHtml } from '@dawaltconley/header-basic';
let header = generateHtml({
name: 'header',
links: [{
text: 'Home',
page: '/'
}, {
text: 'About',
page: '/about/'
}]
});Scss / CSS
The dist/header.css file contains minimal styles that can be used without Scss. However you can more easily customize things with the style mixin.
@use '@dawaltconley/header-basic';
.header-class {
@include header-basic.base($color: #333 white, $transition: .3s .25s);
}JavaScript
For a fixed and collapsible header UI, simply pass the header element (generated above) into the browser submodule.
import makeHeader from '@dawaltconley/header-basic/browser';
let headerElement = document.getElementById('header'); // this id corresponds to the 'name' option
let { original, fixed } = makeHeader(headerElement);With Eleventy
You can import an eleventy plugin directly to add Nunjucks and Liquid tags...
// .eleventy.js
const header = require('@dawaltconley/header-basic');
module.exports = eleventyConfig => {
eleventyConfig.addPlugin(header.eleventy, { tagName: 'header' });
};...configure it in a data file...
# _data/header.yml
links:
- text: Home
page: '/'
- text: About
page: '/about/'
- text: Dropdown
dropdown:
- text: Drop 1
page: '/foo/'
- text: Drop 2
page: '/bar/'
logo:
src: 'http://pigment.github.io/fake-logos/logos/small/color/greens-food-suppliers.png'
alt: Greens Food SuppliersAnd then use these tags in your templates.
<!-- index.html -->
<body>
{% header header, class="other-class another-class", 'data-attr'=null %}
<main>
<p>Some main content</p>
</main>
</body>Components
Table of Contents
default
Create a fixed header and collapsible menu from the same element.
Parameters
Returns Object
FixedHeader
Class representing a fixed/sticky header UI
Parameters
scrollPos
Current scroll position of the scrolling element.
Type: number
pagePosition
Gets the position of the original header within the page.
Parameters
elementElement original header element (optional, defaultthis.headerRef)pageElement scrolling (usually document) element (optional, defaultthis.scrollable)
Returns DOMRect
hideHeaderRef
Hides the original header from screen readers when fixed header is displayed.
showHeaderRef
Reveals the original header to screen readers when fixed header is shown.
scroll
Handles scroll behavior, revealing or hiding fixed header, and triggering slide if partially visible.
disableScroll
Remove scroll listeners
enableScroll
Enable scroll listeners
hide
Hide the fixed header (usually when returning to the top of the document and using the reference header).
matchRef
Matches the fixed header dimensions to the original (reference) header.
resize
Handle window resizing events, since this can change scroll position in page.
slide
Animate sliding the fixed header up or down (into or out of view). Usually based on scroll.
Parameters
direction("up"|"down")callbackfunction? function to call when done sliding (optional, default()=>null)
setShadow
Add a box shadow to the fixed header.
Parameters
sizenumber? number to use to set the shadow height (defaults to visible header size) (optional, defaultparseInt(this.element.style.top)+this.height)
addListeners
Adds all event listeners. Called during construction.
CollapsibleMenu
Class representing a collapsible menu UI.
Parameters
open
Expand the menu.
close
Collapse the menu
toggle
Toggle the menu, collapsed or expanded.
addListeners
Attempts to add listeners for CollapsibleMenu methods. Called during construction.
generateHtml
Generates html for the header element.
Parameters
args...KeywordArguments one or more kwarg objects
Returns string header html
eleventy
Eleventy plugin for the generateHtml function. Supports inserting html via Nunjucks and Liquid tags.
Parameters
eleventyConfigoptionsObject? (optional, default{})options.tagNamestring (optional, default'header')
KeywordArguments
The key/value pairs used in for the generateHtml function and templating tags.
Type: Object
Properties
namestring? base name for element id and BEM classeslinksArray<Link>? array of links displayed in the headerlogo(Logo | string)? header logo. can pass a Logo object or directly pass an html stringiconsIcons? open and close iconsiconOpenstring? html string for the open iconiconClosestring? html string for the close iconattributeNamestring? interpret all other key/value pairs as attribute names/values in the parent<header>element
Link
An object representing a header link.
Type: Object
Properties
textstring the link's text, as displayed to the userpagestring? the href value of the linkdropdownArray<Link>? a nested array of links, visible as a dropdown
Logo
An object representing a logo <img> in the header.
Type: Object
Properties
Icons
An object for open and close icons in the header.
Type: Object