AboutSupportDeveloper GuideVersion 22.3.24

Interface BrowserWorkspacePlatformWindowOptions

interface BrowserWorkspacePlatformWindowOptions {
    disableMultiplePages?: boolean;
    favicon?: string;
    icon?: string | TaskbarIcon;
    isLocked?: boolean;
    navigationButtons?: {
        enabled: false;
    } | {
        enabled: true;
        hotkeysDisabled?: boolean;
    };
    newPageUrl?: string;
    newTabUrl?: string;
    pages: Page[];
    pageTabDimensions?: {
        maxWidth?: string;
        minWidth?: string;
    };
    preventPageClose?: boolean;
    preventPageDrag?: boolean;
    preventPageDragIn?: boolean;
    preventPageDragOut?: boolean;
    title?: string | WindowTitle;
    toolbarOptions?: ToolbarOptions;
    viewTabDimensions?: {
        maxWidth?: string;
        minWidth?: string;
    };
    windowStateButtonOptions?: WindowStateButtonOptions;
    windowType?: WindowType | "enterprise";
}

Properties

disableMultiplePages? favicon? icon? isLocked? navigationButtons? newPageUrl? newTabUrl? pages pageTabDimensions? preventPageClose? preventPageDrag? preventPageDragIn? preventPageDragOut? title? toolbarOptions? viewTabDimensions? windowStateButtonOptions? windowType?

Properties

OptionaldisableMultiplePages

disableMultiplePages?: boolean

Remove the Page UI and only allow a single page in the browser window. Must be set to true for this behavior. If this is not set to false, then an empty pages option will be populated with a single page.

Optionalfavicon

favicon?: string

The favicon to display on the top left of the created browser window.

Optionalicon

icon?: string | TaskbarIcon

Taskbar Icon for the Browser Window. If light and dark icon are defined, then the taskbar icon will change when the scheme changes.

OptionalisLocked

isLocked?: boolean

When true, disables the ability to close pages, drag pages within the window, and drag pages into/out of the window. False by default.

OptionalnavigationButtons

navigationButtons?: {
    enabled: false;
} | {
    enabled: true;
    hotkeysDisabled?: boolean;
}

Use when you want to display navigation buttons in Browser toolbar. Disabled by default.

Example

import * as WP from "@openfin/workspace-platform";

const platform = WP.getCurrentSync();
const browserWin = platform.Browser.createWindow({
  ...,
  workspacePlatform: {
    ...,
    navigationButtons: {
      enabled: true;
    }
  }
});

Example

// With disabled default keyboard shortcuts
const browserWin = platform.Browser.createWindow({
  ...,
  workspacePlatform: {
    ...,
    navigationButtons: {
      enabled: true;
      hotkeysDisabled: true;
    }
  }
});

OptionalnewPageUrl

newPageUrl?: string

Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown. If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.

OptionalnewTabUrl

newTabUrl?: string

Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip. If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.

pages

pages: Page[]

The initial set of pages to add to the created browser window.

OptionalpageTabDimensions

pageTabDimensions?: {
    maxWidth?: string;
    minWidth?: string;
}

Specifies the min and max sizes for page tabs. Page tabs will expand to take all available space up to the specified maximum size. Similarly, they will collapse down to the specified minimum size. When there is not enough room to fit the tabs, the tabstrip will become scrollable. Sizes can be specified as pixels (e.g. "100px") or as percentage of tab strip width (e.g. "20%"). The default value for both min and max is "120px". To maintain usability, minimum values below 28px will be ignored and 28px will be used as the minimum.

OptionalpreventPageClose

preventPageClose?: boolean

When true, disables the ability to close pages in the window. False by default.

OptionalpreventPageDrag

preventPageDrag?: boolean

When true, page tabs in the window will not be draggable. This includes reordering pages and dragging them out of the window. False by default.

OptionalpreventPageDragIn

preventPageDragIn?: boolean

When true, disables the ability to drag pages into the window. False by default.

OptionalpreventPageDragOut

preventPageDragOut?: boolean

When true, disables the ability to drag pages out of a window. False by default.

Optionaltitle

title?: string | WindowTitle

A UI friendly title for the created browser window. Type string for window title is deprecated, please use WindowTitle type instead.

OptionaltoolbarOptions

toolbarOptions?: ToolbarOptions

OptionalviewTabDimensions

viewTabDimensions?: {
    maxWidth?: string;
    minWidth?: string;
}

Specifies the min and max sizes for view tabs in a layout. View tabs will expand to take all available space up to the specified maximum size. Similarly, they will collapse down to the specified minimum size. When there is not enough room to fit the tabs, the tabstrip will become scrollable. Sizes can be specified as pixels (e.g. "100px") or as percentage of tab strip width (e.g. "20%"). The default value for both min and max is "120px". To maintain usability, minimum values below 28px will be ignored and 28px will be used as the minimum.

OptionalwindowStateButtonOptions

windowStateButtonOptions?: WindowStateButtonOptions

OptionalwindowType

windowType?: WindowType | "enterprise"

For internal usage. Defaults to 'browser' when Browser is enabled when the WorkspacePlatform is initialized. In order to use non-Browser layout windows ('platform' windows) in a Browser-enabled workspace platform, set windowType to platform. In that instance, the other properties in the workspacePlatform object are not relevant.

Settings

On This Page

Properties