IDocumentTitleChangedEvent

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

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

Event setting the page-title segment of the browser tab title on the host.

Signature:

export interface IDocumentTitleChangedEvent extends IPluggableAppEvent 

Extends: IPluggableAppEvent

Remarks

The host owns document.title and composes it as "{pageTitle} - {brand}". A pageTitle of undefined tells the host to fall back to the application's manifest title.

Properties

Property	Modifiers	Type	Description
payload	readonly	{ readonly pageTitle: string | undefined; }	(ALPHA)
type	readonly	"GDC.PLUGGABLE_APP/EVT.DOCUMENT_TITLE.CHANGED"	(ALPHA)