OpenFin Workspace Platform API
    Preparing search index...

    Interface BrowserInitConfig

    Configuration for initializing a Browser.

    interface BrowserInitConfig {
        accessibilityOptions?: AccessibilityOptions;
        allowDuplicatePageTitles?: boolean;
        browserIconSize?: IconSize;
        defaultPageOptions?: Pick<
            Page,
            "iconUrl"
            | "unsavedIconUrl"
            | "closeButton"
            | "panels",
        >;
        defaultViewOptions?: Partial<BrowserCreateViewRequest>;
        defaultWindowOptions?: Partial<BrowserCreateWindowRequest>;
        indicators?: WorkspaceIndicatorConfig;
        interopOverride?: OverrideCallback<InteropBroker, InteropBroker>;
        overrideCallback?: WorkspacePlatformOverrideCallback;
        title?: string;
    }
    Index
    accessibilityOptions? allowDuplicatePageTitles? browserIconSize? defaultPageOptions? defaultViewOptions? defaultWindowOptions? indicators? interopOverride? overrideCallback? title?
    accessibilityOptions?: AccessibilityOptions

    Default accessibility options that will be applied to all browser windows. These options can be overridden at the window creation level via workspacePlatform.accessibilityOptions.

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

    await WorkspacePlatform.init({
      browser: {
        title: "My Browser",
        accessibilityOptions: {
          viewTabOptions: {
            arrowNavigation: ["inactive-tab", "active-tab"],
            tabNavigation: ["active-tab"]
          }
        }
      }
    });
    allowDuplicatePageTitles?: boolean

    When true, allows multiple pages to share the same title across browser windows. No numeric suffixes are appended and attach/add operations will not reject on title collision. pageId remains the unique identifier for all page operations.

    Defaults to false (current unique-title behavior preserved).

    browserIconSize?: IconSize

    By default, the icons in the browser are displayed at the default size. If you want to display the icons at a larger size, set this property to 'large'. This will increase the size of the icons in the browser. If you have custom icons that are PNGs you will need to update these assets for best results.

    defaultPageOptions?: Pick<
        Page,
        "iconUrl"
        | "unsavedIconUrl"
        | "closeButton"
        | "panels",
    >

    Default options when creating a new page. If iconUrl, unsavedIconUrl, panels or closeButton are not defined when creating a page, setting will default to defaultPageOptions.

    defaultViewOptions?: Partial<BrowserCreateViewRequest>

    The default options when creating a new view. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.

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

    await WorkspacePlatform.init({
      browser: {
        defaultViewOptions: {
          workspacePlatform: {
            browserNavigationButtons: {
              back: true,
              forward: true,
              reload: true
            }
          }
        }
      }
    });
    defaultWindowOptions?: Partial<BrowserCreateWindowRequest>

    Default options for creating a new Browser window. These options are not applied on any non-Browser windows that get created. These default options will take precedence over defaultWindowOptions included in the manifest. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createWindow(options) call will default to the value provided in this field.

    indicators?: WorkspaceIndicatorConfig

    Opt-in suppression flags for workspace success indicators. Both flags default to false; existing platforms see no behaviour change.

    await WorkspacePlatform.init({
      browser: {
        indicators: {
          suppressWorkspaceSwitched: true,
          suppressWorkspaceSaved: true,
        },
      },
    });
    interopOverride?: OverrideCallback<InteropBroker, InteropBroker>

    Override workspace platform interop behavior

    https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html

    overrideCallback?: WorkspacePlatformOverrideCallback

    Override workspace platform behavior

    Please use the overrideCallback property of WorkspacePlatformInitConfig

    title?: string

    The platform title. UI friendly title for the platform in browser.

    Settings

    On This Page
    Properties