# Header API

The Header API provides access to the Header UI component.

# Module

Unlike older Javascript APIs available globally via prism, the Header API is provided as a standalone module and needs to be loaded explicitly. See Using API Modules for more information.

Module name: api.v1.header

Example:

var headerApi = prism.getApi('api.v1.header');

# Methods

# isVisible()

Is the header currently displayed

Arguments

N/A

Returns

boolean

# hide()

Hide the header entirely

Arguments

N/A

Returns

N/A

# show()

Show the header

Arguments

N/A

Returns

N/A

# on(eventName, eventHandler)

Subscribe a handler to an application event

Arguments

Returns

N/A

# off(eventName, eventHandler)

Un-subscribe a handler from an application event

Arguments

Returns

N/A

# getTabs()

Get an array of current header tabs

Arguments

N/A

Returns

Array.<HeaderTab>

# getTab(id)

Get a specific tab

Arguments

Returns

HeaderTab

# addTab(tab, [index])

Add one tab

Arguments

Returns

N/A

# addTabs(tabs, [index])

Add multiple tabs

Arguments

Returns

N/A

# updateTab(tab)

Update one tab - based on tab's ID

Arguments

Returns

N/A

# removeTab(id)

Remove a specific tab

Arguments

Returns

N/A

# getActiveTab()

Get the current active tab

Arguments

N/A

Returns

HeaderTab

# setActiveTab(id)

Set the current active tab

Arguments

Returns

N/A

# getIcon()

Get an array of current header icons

Arguments

N/A

Returns

Array.<HeaderIcon>

# getIcon(id)

Get a specific icon

Arguments

Returns

HeaderIcon

# addIcon(icon, [index])

Add one icon

Arguments

Returns

N/A

# addIcons(icons, [index])

Add multiple icons

Arguments

Returns

N/A

# updateIcon(icon)

Update one icon - based on icon's ID

Arguments

Returns

N/A

# removeIcon(id)

Remove a specific icon

Arguments

Returns

N/A

# getLogo()

Get current logo settings

Arguments

N/A

Returns

HeaderLogo

# updateLogo(logoSettings)

Update the header logo

Arguments

Returns

N/A

# hideLogo()

Hide the header logo

Arguments

N/A

Returns

N/A

# showLogo()

Show the header logo

Arguments

N/A

Returns

N/A

# getHeaderElement()

Get the entire header's DOM element

Arguments

N/A

Returns

DOMElement

# Types

# HeaderTab

A header tab item

Properties

# HeaderIcon

A header icon item

Properties

# HeaderLogo

The header logo

Properties

# Events

# "created"

Fires when the header is created

Properties

# "destroyed"

Fires when the header is destroyed

Properties

# "hidden"

Fires when the header is hidden

Properties

# "shown"

Fires when the header is shown

Properties

# "logoaction"

Fires when the header logo element is clicked

Properties

# "tabaction"

Fires when a header navigation tab element is clicked

Properties

# "iconaction"

Fires when a header icon item element is clicked

Properties