Origami Frontend Components & Services

JSDoc: o-header-services

new Drawer(headerEl)

Class constructor.

parameter type default description
headerEl (optional) HTMLElement The component element in the DOM

Methods

Links

new HeaderServices(headerEl)

Class constructor

parameter type default description
headerEl (optional) HTMLElement The component element in the DOM

Methods

Links

new Scroll(headerEl)

Class constructor

parameter type default description
headerEl (optional) HTMLElement The component element in the DOM

Methods

Links

Drawer#handleEvent(event)

Instance Method

Event Handler

parameter type default description
event Object The revent emitted by element/window interactions

Links

Drawer#render

Instance Method

Drawer rendering

Links

Drawer#toggleDrawer

Instance Method

Drawer hide/show functionality

Links

HeaderServices.init(rootElement, options)

Static Method

Initialise header component

parameter type default description
rootElement HTMLElement | String The root element to intialise the component in, or a CSS selector for the root element
options (optional) Object {} An options object for configuring the component

Links

Scroll#render

Instance Method

Scroll functionality rendering

Links

Scroll#toggleScrollButtons

Instance Method

Hide/show scroll buttons

Links

Scroll#scroll

Instance Method

Scrolling functionality

Links

Scroll#showCurrentSelection

Instance Method

Scroll secondary nav to 'current selection'

Links

Switch component view

GitHub Repository

Install o-header-services

If using the Build Service, add o-header-services@^3.3.0 to your script and link tags.

If running a Manual Build, run bower install --save "o-header-services@^3.3.0".

Help & Support

o-header-services is maintained directly by the Origami team. If you have any questions about o-header-services or Origami in general, we are happy to help. 😊

Slack: #ft-origami
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #ft-origami
Email: origami.support@ft.com