onHeaderChange

Home > @gooddata/sdk-pluggable-application-model > IPluggableApplicationMountOptions > onHeaderChange

IPluggableApplicationMountOptions.onHeaderChange property

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.

Callback invoked by the pluggable application to push chrome customizations to the host shell.

Signature:

onHeaderChange?: (header: IAppHeaderOptions) => void;

Remarks

Call this at mount time to declare the application's preferred header configuration (e.g. help menu items). Can be called again at any time to update the configuration — for example after a locale change that affects translated item labels.

The provided object replaces the current header options entirely. The host falls back to its own defaults for any fields not present.