A window that is part of a browser snapshot.
The payload received by a Custom Action.
The callerType
property can be used to determine what data is available in the payload and cast accordingly.
When callerType == CustomActionCallerType.API
, the payload is defined by the code directly invoking the action.
Payload received by the openGlobalContextMenu provider override.
Payload received by the openViewTabContextMenu provider override.
Payload received by the openSaveButtonContextMenu provider override.
Request to create a save modal.
Payload received by the openViewTabContextMenu provider override.
Buttons on the left of WindowStateButtonOptions
Buttons to the top far right of Browser
Initilaize a Workspace Platform.
import * as WorkspacePlatform from '@openfin/workspace-platform';
const customThemes: WorkspacePlatform.CustomThemes = [{
label: "OpenFin's Custom Theme",
palette: {
// Required color options
brandPrimary: '#F51F63',
brandSecondary: '#1FF58A',
backgroundPrimary: '#F8E71C', // hex, rgb/rgba, hsl/hsla only - no string colors: 'red'
}
}
const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
WorkspacePlatformProvider
) => {
class Override extends WorkspacePlatformProvider {
async quit(payload, callerIdentity) {
return super.quit(payload, callerIdentity);
}
}
return new Override();
};
await WorkspacePlatform.init({
browser: { overrideCallback },
theme: customThemes
});
options for configuring the platform.
Generated using TypeDoc
Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.
To implement your own handlers for Workspace Platform behavior, extend the provided class and override any methods you'd like to alter.