getCustomHeaderItems()

Retrieves the current set of custom header items that are configured in the chat widget. You can use the output to access and inspect the custom menu items that are currently displayed in the chat header.

Syntax

const items = instance.getCustomHeaderItems();

Parameters

None

Returns

CustomHeaderItem[]

Returns an array of custom header item objects currently configured in the chat.

Examples

The following example gets current custom header items:

// Get current custom header items
const currentItems = instance.getCustomHeaderItems();
console.log('Current header items:', currentItems);

// Check if a specific item exists
const hasHelpButton = currentItems.some(item => item.id === 'help-button');

Do you need practical examples?

Learn how to apply the features available for embedded chat into your implementation with guidance and examples.

changeView()

getWriteableElement()

Release Notes

Get Started

Build

Deploy

Analyze

Developer experience

Legal notices

Syntax

Parameters

Returns

Examples

Do you need practical examples?

​Syntax

​Parameters

​Returns

​Examples

Do you need practical examples?

Syntax

Parameters

Returns

Examples