ISwitchDashboardTabPayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Payload of the ISwitchDashboardTab command.
export interface ISwitchDashboardTabPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (ALPHA) (Optional) What triggered this tab switch. | ||
| string | (ALPHA) Identifier of the tab to switch to. |
Property details
ISwitchDashboardTabPayload.sourcepropertyAlpha
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;
Remarks
Omit for a regular user-initiated tab switch. See DashboardTabSwitchSource for the recognized values and their effect.
ISwitchDashboardTabPayload.tabIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Identifier of the tab to switch to.
readonly tabId: string;