JSDoc: o-header-services

new Drawer(headerEl)

Class constructor.

Methods

• handleEvent(event) - (instance) Event Handler
• render - (instance) Drawer rendering
• toggleDrawer - (instance) Drawer hide/show functionality

Properties

• enabled - Check if the drawer is currently enabled. If the burger element is visible, the drawer is enabled.

Links

• "Drawer" class on Github

new DropDown(headerEl, drawer)

Class constructor

Methods

• handleEvent(event) - (instance) Event Handler
• isDrawer - (instance) Checks if primary nav is in a drawer This boolean will change the drop down behaviour.
• reset - (instance) Returns nav items to their original collapsed state, items which contain links with the attribute `aria-current` set to true remain expanded.
• isExpanded(item) - (static) Checks whether nav menu is expanded
• expand(item) - (static) Expands closed nav menu
• position(item) - (static) Changes nav menu position relative to the window
• collapse(item) - (static) Collapses open nav menu
• collapseAll(items) - (static) Collapses all open nav menus
• expandAll(items) - (static) Expands all open nav menus
• getCurrent(items) - (static) Returns items which contain an anchor with the attribute `aria-current` set to true or "page".

Properties

• navItems - (type: Array.<Element>) - Nav items with a dropdown.

Links

• "DropDown" class on Github

new HeaderServices(headerEl)

Class constructor

Methods

• init(rootElement, options) - (static) Initialise header component

Links

• "HeaderServices" class on Github

new Scroll(headerEl)

Class constructor

Methods

• render - (instance) Scroll functionality rendering
• toggleScrollButtons - (instance) Hide/show scroll buttons
• scroll(event) - (instance) Scrolling functionality
• showCurrentSelection - (instance) Scroll secondary nav to 'current selection'

Links

• "Scroll" class on Github

Drawer#handleEvent(event)

Instance Method

Event Handler

Returns

• void

Links

• "handleEvent" function on Github

Drawer#enabled

Instance Property

Check if the drawer is currently enabled. If the burger element is visible, the drawer is enabled.

Links

• "enabled" member on Github

Drawer#render

Instance Method

Drawer rendering

Returns

• void

Links

• "render" function on Github

Drawer#toggleDrawer

Instance Method

Drawer hide/show functionality

Returns

• void

Links

• "toggleDrawer" function on Github

DropDown#navItems

Instance Property

Type

• Array.<Element>

- Nav items with a dropdown.

Links

• "navItems" member on Github

DropDown#handleEvent(event)

Instance Method

Event Handler

Returns

• void

Links

• "handleEvent" function on Github

DropDown#isDrawer

Instance Method

Checks if primary nav is in a drawer This boolean will change the drop down behaviour.

Returns

• boolean - - whether the drawer is enabled or not

Links

• "isDrawer" function on Github

DropDown#reset

Instance Method

Returns nav items to their original collapsed state, items which contain links with the attribute aria-current set to true remain expanded.

Returns

• void

Links

• "reset" function on Github

DropDown.isExpanded(item)

Static Method

Checks whether nav menu is expanded

Returns

• boolean - - whether the nav menu is expanded

Links

• "isExpanded" function on Github

DropDown.expand(item)

Static Method

Expands closed nav menu

Returns

• void

Links

• "expand" function on Github

DropDown.position(item)

Static Method

Changes nav menu position relative to the window

Returns

• void

Links

• "position" function on Github

DropDown.collapse(item)

Static Method

Collapses open nav menu

Returns

• void

Links

• "collapse" function on Github

DropDown.collapseAll(items)

Static Method

Collapses all open nav menus

Returns

• void

Links

• "collapseAll" function on Github

DropDown.expandAll(items)

Static Method

Expands all open nav menus

Returns

• void

Links

• "expandAll" function on Github

DropDown.getCurrent(items)

Static Method

Returns items which contain an anchor with the attribute aria-current set to true or "page".

Returns

• HTMLElement - - The current menu item

Links

• "getCurrent" function on Github

HeaderServices.init(rootElement, options)

Static Method

Initialise header component

Returns

• Array.<HTMLElement> | HTMLElement - - The header(s) initalised.

Links

• "init" function on Github

Scroll#render

Instance Method

Scroll functionality rendering

Returns

• void

Links

• "render" function on Github

Scroll#toggleScrollButtons

Instance Method

Hide/show scroll buttons

Returns

• void

Links

• "toggleScrollButtons" function on Github

Scroll#scroll(event)

Instance Method

Scrolling functionality

Returns

• void

Links

• "scroll" function on Github

Scroll#showCurrentSelection

Instance Method

Scroll secondary nav to 'current selection'

Returns

• void

Links

• "showCurrentSelection" function on Github