WorkspacePlatformInitConfig | @openfin/workspace-platform

Configuration for initializing a Workspace platform.

Hierarchy

WorkspacePlatformInitConfig

Index

Properties

Optional analytics

analytics?: AnalyticsConfig

Config for Workspace Platform analytics

Optional browser

browser?: BrowserInitConfig

Config for overriding browser options and behavior. Set to null to initialize the platform without the browser

Optional customActions

customActions?: CustomActionsMap

Optional integrations

integrations?: WorkflowIntegration[]

Config for Workspace Platform Integrations

example

import * as WorkspacePlatform from '@openfin/workspace-platform';
import { Integrations } from '@openfin/workspace';

const microsoftIntegration = new Integrations.Microsoft365WorkflowIntegration({
    connect: {
        clientId: '',
        redirectUri: '',
        tenantId: ''
    }
});

await WorkspacePlatform.init({
  browser: { },
  integrations: [microsoftIntegration]
});

Optional interopOverride

interopOverride?: OverrideCallback<InteropBroker, InteropBroker>

Override workspace platform interop behavior https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html

Optional overrideCallback

overrideCallback?: WorkspacePlatformOverrideCallback

Override workspace platform behavior

Optional theme

theme?: CustomThemes

Custom Themes object

import * as WorkspacePlatform from '@openfin/workspace-platform';

// This is the palette used to create the OpenFin dark theme
const customPalette: WorkspacePlatform.CustomPaletteSet = {
  brandPrimary: '#504CFF',
  brandSecondary: '#383A40',
  backgroundPrimary: '#000',
  background1: '#111214',
  background2: '#1E1F23',
  background3: '#24262B',
  background4: '#2F3136',
  background5: '#383A40',
  background6: '#53565F',
  statusSuccess: '#35C759',
  statusWarning: '#C93400',
  statusCritical: '#000',
  statusActive: '#0879C4',
  inputBackground: '#53565F',
  inputColor: '#FFFFFF',
  inputPlaceholder: '#C9CBD2',
  inputDisabled: '#7D808A',
  inputFocused: '#C9CBD2',
  textDefault: '#FFFFFF',
  textHelp: '#C9CBD2',
  textInactive: '#7D808A',
};

const customTheme: WorkspacePlatform.CustomThemes = [{
  label: "My Custom Theme",
  palette: customPalette
}];

await WorkspacePlatform.init({
  browser: {
     title: "My Browser"
  },
  theme: customThemes,
  overrideCallback
});