updateHeader()

Home > @gooddata/sdk-pluggable-application-model > IHostUiMountHandle > updateHeader

IHostUiMountHandle.updateHeader() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Pushes updated header options into the host UI.

Signature:

updateHeader?(header: IAppHeaderOptions | undefined): void;

Parameters

Parameter	Type	Description
header	IAppHeaderOptions | undefined

Returns:

void

Remarks

Called by the host whenever the active pluggable application declares new header options via its onHeaderChange callback. The host UI uses this to update the header (e.g. help menu items) to match the active application's preferences. When called with undefined, the host UI should revert to its default header configuration.