IAppHeaderOptions

Home > @gooddata/sdk-pluggable-application-model > IAppHeaderOptions

IAppHeaderOptions interface

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.

Header customization options that a pluggable application can push to the host shell.

Signature:

export interface IAppHeaderOptions

Remarks

The host shell owns the application header. A pluggable application can declare its preferred header configuration by calling the IPluggableApplicationMountOptions.onHeaderChange callback at mount time or whenever the configuration needs to change (e.g. after locale switch).

All fields are optional — only the fields provided are applied; the host uses its own defaults for anything not specified.

Properties

Property

Modifiers

Type

Description

helpMenuItems?

Array<{ key: string; label?: string; href?: string; target?: string; className?: string; iconName?: string; }>

(ALPHA) (Optional) Help menu items to show in the host header when this application is active.

← IApiTokenAuthCredentialsIAppInstance →