IDashboardTabSwitchedPayload

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Payload of the IDashboardTabSwitched event.

export interface IDashboardTabSwitchedPayload

Properties

Property	Modifiers	Type	Description
newTabId	`readonly`	string	*(ALPHA)* Identifier of the newly active tab.
previousTabId	`readonly`	string \| undefined	*(ALPHA)* Identifier of the previously active tab (undefined if no tab was active).
source?	`readonly`	DashboardTabSwitchSource	*(ALPHA)* (Optional) What triggered this tab switch.

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Identifier of the newly active tab.

readonly newTabId: string;

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Identifier of the previously active tab (undefined if no tab was active).

readonly previousTabId: string | undefined;

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

What triggered this tab switch.

readonly source?: DashboardTabSwitchSource;

Omit for a regular user-initiated tab switch. See DashboardTabSwitchSource for the recognized values and their effect.