IShellUiMountOptions

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

IShellUiMountOptions 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.

Options passed by the host into a shell UI module's mount function.

Signature:

export interface IShellUiMountOptions

Properties

Property

Modifiers

Type

Description

container

HTMLElement

(ALPHA) DOM element into which the shell UI should render itself.

ctx

IPlatformContext

(ALPHA) Platform context snapshot provided by the host.

navigate

(url: string) => void

(ALPHA) Callback for requesting client-side navigation (push).

pathname

string

(ALPHA) Current pathname of the host application.

replace

(url: string) => void

(ALPHA) Callback for requesting client-side navigation with history replacement.

resolvedApplications

PluggableApplicationRegistryItem[]

(ALPHA) Resolved and filtered list of pluggable applications to render in the navigation.

← IShellUiMountHandleisPlatformContextV1() →