Interface BrowserWorkspacePlatformWindowOptions

interface BrowserWorkspacePlatformWindowOptions {
    accessibilityOptions?: AccessibilityOptions;
    disableFindInPage?: boolean;
    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;
    tabSearchButton?: TabSearchButtonOptions;
    title?: string | WindowTitle;
    toolbarOptions?: ToolbarOptions;
    viewTabDimensions?: {
        maxWidth?: string;
        minWidth?: string;
        widthMode?: ViewTabWidthMode;
    };
    windowStateButtonOptions?: WindowStateButtonOptions;
    windowType?: WindowType
    | "enterprise";
}

Properties

`Optional`accessibilityOptions

accessibilityOptions?: AccessibilityOptions

Accessibility options for the browser window. These options override the default accessibility options set at the platform or browser initialization level.

Example

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

const platform = WorkspacePlatform.getCurrentSync();
const browserWin = platform.Browser.createWindow({
  ...,
  workspacePlatform: {
    ...,
    accessibilityOptions: {
      viewTabOptions: {
        arrowNavigation: ["inactive-tab", "active-tab"],
        tabNavigation: ["active-tab"]
      }
    }
  }
});

`Optional`disableFindInPage

disableFindInPage?: boolean

When true, disables the find in page feature for the window. The find in page view will not be created and no find in page logic will run. This option must be set at window creation time and cannot be changed dynamically. False by default.

`Optional`disableMultiplePages

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.

`Optional`favicon

favicon?: string

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

`Optional`icon

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.

`Optional`isLocked

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.

`Optional`navigationButtons

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;
    }
  }
});

`Optional`newPageUrl

newPageUrl?: string

URL used for new-page and new-window actions.

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.

This does not automatically control a newly created window's initial content; a caller of Browser.createWindow must include a page using this URL in pages.

`Optional`newTabUrl

newTabUrl?: string

URL used for new-tab actions: the plus button in the tabstrip, the new-tab hotkey, and the "New tab" context menu entry.

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.

This does not control a newly created window's initial content; that comes from pages.

pages

pages: Page[]

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

`Optional`pageTabDimensions

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.

`Optional`preventPageClose

preventPageClose?: boolean

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

`Optional`preventPageDrag

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.

`Optional`preventPageDragIn

preventPageDragIn?: boolean

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

`Optional`preventPageDragOut

preventPageDragOut?: boolean

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

`Optional`tabSearchButton

tabSearchButton?: TabSearchButtonOptions

Controls whether tab-search chevron buttons are shown for page tabs and view tabs.

By default, both locations are disabled unless explicitly enabled.

Example

workspacePlatform: {
  tabSearchButton: {
    viewTabs: { enabled: true },
    pageTabs: { enabled: true }
  }
}

Example

workspacePlatform: {
  tabSearchButton: {
    viewTabs: { enabled: true },
    // pageTabs omitted: disabled
  }
}

`Optional`title

title?: string | WindowTitle

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

`Optional`toolbarOptions

toolbarOptions?: ToolbarOptions

`Optional`viewTabDimensions

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

Specifies the min and max sizes for view tabs in a layout, and how those widths are calculated. 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%"). Defaults depend on the width mode: 'uniform' uses "120px" for both bounds, while 'content' sizes a tab to its own chrome and so applies no minimum and a "200px" maximum. To maintain usability, minimum values below 28px will be ignored and 28px will be used as the minimum.

Type Declaration

OptionalmaxWidth?: string
OptionalminWidth?: string
OptionalwidthMode?: ViewTabWidthMode
Controls how view tab widths are calculated.
- 'uniform' (default): current equal-width tab behavior.
- 'content': tab width is driven by tab chrome (label, favicon, spinner, controls) within min/max bounds.

Example

workspacePlatform: {
  viewTabDimensions: {
    widthMode: 'content',
    minWidth: '50px',
    maxWidth: '200px'
  }
}

`Optional`windowStateButtonOptions

windowStateButtonOptions?: WindowStateButtonOptions

`Optional`windowType

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.

Interface BrowserWorkspacePlatformWindowOptions

Index

Properties

Properties

`Optional`accessibilityOptions

Example

`Optional`disableFindInPage

`Optional`disableMultiplePages

`Optional`favicon

`Optional`icon

`Optional`isLocked

`Optional`navigationButtons

Example

Example

`Optional`newPageUrl

`Optional`newTabUrl

pages

`Optional`pageTabDimensions

`Optional`preventPageClose

`Optional`preventPageDrag

`Optional`preventPageDragIn

`Optional`preventPageDragOut

`Optional`tabSearchButton

Example

Example

`Optional`title

`Optional`toolbarOptions

`Optional`viewTabDimensions

Type Declaration

`Optional`maxWidth?: string

`Optional`minWidth?: string

`Optional`widthMode?: ViewTabWidthMode

Example

`Optional`windowStateButtonOptions

`Optional`windowType

Settings

On This Page

Interface BrowserWorkspacePlatformWindowOptions

Index

Properties

Properties

OptionalaccessibilityOptions

Example

OptionaldisableFindInPage

OptionaldisableMultiplePages

Optionalfavicon

Optionalicon

OptionalisLocked

OptionalnavigationButtons

Example

Example

OptionalnewPageUrl

OptionalnewTabUrl

pages

OptionalpageTabDimensions

OptionalpreventPageClose

OptionalpreventPageDrag

OptionalpreventPageDragIn

OptionalpreventPageDragOut

OptionaltabSearchButton

Example

Example

Optionaltitle

OptionaltoolbarOptions

OptionalviewTabDimensions

Type Declaration

OptionalmaxWidth?: string

OptionalminWidth?: string

OptionalwidthMode?: ViewTabWidthMode

Example

OptionalwindowStateButtonOptions

OptionalwindowType

Settings

On This Page

`Optional`accessibilityOptions

`Optional`disableFindInPage

`Optional`disableMultiplePages

`Optional`favicon

`Optional`icon

`Optional`isLocked

`Optional`navigationButtons

`Optional`newPageUrl

`Optional`newTabUrl

`Optional`pageTabDimensions

`Optional`preventPageClose

`Optional`preventPageDrag

`Optional`preventPageDragIn

`Optional`preventPageDragOut

`Optional`tabSearchButton

`Optional`title

`Optional`toolbarOptions

`Optional`viewTabDimensions

`Optional`maxWidth?: string

`Optional`minWidth?: string

`Optional`widthMode?: ViewTabWidthMode

`Optional`windowStateButtonOptions

`Optional`windowType