@interopio/desktop API Reference

Options for starting an app.

Properties (68)

Property Type Default Required Description
allowClose⚓︎ boolean true x

If true, the window will contain a "Close" button.
allowCollapse⚓︎ boolean false x

If true, the window will contain a "Collapse/Expand" button.
allowExtract⚓︎ boolean false x

If true, the window will contain an "Extract" button when in a window group. The button can be used to break out the window from the window group.
allowLockUnlock⚓︎ boolean false x

If true, the window will contain a "Lock/Unlock" button.
allowMaximize⚓︎ boolean true x

If true, the window will contain a "Maximize" button.
allowMinimize⚓︎ boolean true x

If true, the window will contain a "Minimize" button.
allowTabClose⚓︎ boolean true x

If true, the tab header will contain a "Close" button.
allowUnstick⚓︎ boolean true x

If true, the window will be able to unstick from other io.Connect Windows.
autoAlign⚓︎ boolean true x

If true, a snapped window will adjust its bounds to the same width/height of the window it has stuck to, and will occupy the space between other windows, if any.
autoSnap⚓︎ boolean true x

If true, when moving the window operation ends, the window will snap to one of the approaching edges of another window, if it's close enough.
awaitInterop⚓︎ boolean true x

If true, will wait for the Interop library to be initialized.
base64ImageSource⚓︎ string x x

Base64 image that will be used as a taskbar icon for the window. The supported formats are PNG, ICO, JPG and APNG.
borderColor⚓︎ string x x

Color for the window border. Can be a color name such as "red", or a hexadecimal RGB or ARGB value.
buttonsVisibility⚓︎ "off" | "onDemand" | "always" | "onFocus" "onDemand" x

Determines the conditions under which the window buttons will be visible. Valid only for io.Connect Windows with mode set to "html".
cascade⚓︎ CascadeSettings x x

Settings for opening new window instances of the same app in a cascade.
channelSelector⚓︎ ChannelSelector x x

Settings for the Channel Selector UI.
collapseHeight⚓︎ number -1 x

Defines the height of the window when collapsed.
devToolsEnable⚓︎ boolean true x

If true, allows opening a developer console using F12 for the new window.
downloadSettings⚓︎ DownloadSettings x x

Defines the file download behavior of the window.
env⚓︎ Record<string, (string)> x x

Key/value pairs that will be merged with the process.env object when spawning a new process for an executable app from the Node.js environment.
focus⚓︎ boolean true x

If true, the window will be on focus when created.
hasMoveAreas⚓︎ boolean true x

If true, the window will have move areas and the user will be able to move it. Valid only for HTML and frameless io.Connect Windows.
hasSizeAreas⚓︎ boolean true x

If true, the user will be able to resize the window by dragging its borders.
height⚓︎ number 400 x

Window height in pixels.
hidden⚓︎ boolean false x

If true, the window will be started as a hidden window.
historyNavigationEnabled⚓︎ boolean true x

If true, this will allow the users to navigate back (CTRL + Left) and forward (CTRL + Right) through the web page history.
ignoreFromLayouts⚓︎ boolean x x

If true, the window won't be saved when saving a Layout, nor closed or restored when restoring a Layout.
ignoreSavedLayout⚓︎ boolean false x

If true, the App Default Layout of the app (last saved bounds, context, window state) will be ignored when starting the app. The app will always start with the bounds, context and state specified in its configuration.
isChild⚓︎ boolean false x

If true, the window will open as a child window, sharing the lifetime and the environment of the opener. This property won't work if the window is opened by a Workspaces App or a Web Group App.
isCollapsed⚓︎ boolean false x

If true, the window will start collapsed.
isSticky⚓︎ boolean true x

If true, the window will stick to other io.Connect Windows forming groups.
left⚓︎ number 0 x

Distance of the top left window corner from the left edge of the screen in pixels.
loader⚓︎ Loader x x

Defines loader behavior.
maxHeight⚓︎ number x x

Specifies the maximum window height in pixels.
maxWidth⚓︎ number x x

Specifies the maximum window width in pixels.
minHeight⚓︎ number 30 x

Specifies the minimum window height in pixels.
minWidth⚓︎ number 50 x

Specifies the minimum window width in pixels.
mode⚓︎ WindowMode "flat" x

io.Connect Window mode. Possible values are "flat", "tab", "html" and "frameless".
moveAreaBottomMargin⚓︎ string "0, 0, 0, 0" x

Margin for the move area located at the bottom border of the window. The string value corresponds to the left, top, right and bottom borders of the move area. Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area. Valid only for io.Connect Windows with mode set to "html".
moveAreaLeftMargin⚓︎ string "0, 0, 0, 0" x

Margin for the move area located at the left border of the window. The string value corresponds to the left, top, right and bottom borders of the move area. Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area. Valid only for io.Connect Windows with mode set to "html".
moveAreaRightMargin⚓︎ string "0, 0, 0, 0" x

Margin for the move area located at the right border of the window. The string value corresponds to the left, top, right and bottom borders of the move area. Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area. Valid only for io.Connect Windows with mode set to "html".
moveAreaThickness⚓︎ string "0, 12, 0, 0" x

How much of the window area is to be considered as a moving area. The string value corresponds to the left, top, right and bottom borders of the window. Setting this to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window. Valid only for io.Connect Windows with mode set to "html".
moveAreaTopMargin⚓︎ string "0, 0, 0, 0" x

Margin for the move area located at the top border of the window. The string value corresponds to the left, top, right and bottom borders of the move area. Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area. Valid only for io.Connect Windows with mode set to "html".
onTop⚓︎ boolean false x

If true, the window will appear on top of the Z-order.
parameters⚓︎ string x x

Optional parameters that will be passed to the executable app that is to be started. The value will be used as is and no validation will be performed on it.
placement⚓︎ PlacementSettings x x

Specifies the window position relative to the screen.
preloadScripts⚓︎ string[] x x

A list of preload scripts (URLs) that will be loaded and executed before the actual page is executed.
relativeDirection⚓︎ RelativeDirection "right" x

Direction for positioning the window relatively to the window specified in the relativeTo property. Considered only if relativeTo is supplied. Possible values are "bottom", "top", "left"and "right".
relativeTo⚓︎ string | IOConnectWindow x x

ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.
showInTaskbar⚓︎ boolean true x

If true, the window icon will appear on the Windows taskbar. This property won't work for apps of type "exe", unless they are registered as io.Connect Windows.
showTitleBar⚓︎ boolean true x

If true, the window will have a title bar.
sizeAreaThickness⚓︎ string "5, 5, 5, 5" x

How much of the window area in pixels is to be considered as a sizing area. The string value corresponds to the left, top, right and bottom borders of the window. Valid only for io.Connect Windows with mode set to "html".
snappingEdges⚓︎ string "all" x

Specifies the active io.Connect Window snapping edges. Possible values are "top", "left", "right", "bottom" and "all", or any combination of them (e.g., "left, right").
startLocation⚓︎ string x x

Specifies the window start location. Possible options are "center", "topCenter", "bottomCenter", "leftCenter", "rightCenter", "full", "topFull", "bottomFull", "leftFull" and "rightFull".
stickyFrameColor⚓︎ string "#5b8dc9" x

Specifies the io.Connect Window frame color. Accepts a hexadecimal color as string (e.g., "#666666") or named HTML colors (e.g., "red").
stickyGroup⚓︎ string "Any" x

If set, the io.Connect Window can only stick to windows that have the same group.
tabGroupId⚓︎ string x x

Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same container as tabs.
tabIndex⚓︎ number x x

The tab index of the current window. All tabs in a common tab container have different indices.
tabSelected⚓︎ boolean true x

If true, the tab will be selected.
tabTitle⚓︎ string "" x

Sets the tab title.
tabTooltip⚓︎ string "" x

Sets the tab tooltip.
timeout⚓︎ number x x

Interval in seconds to wait for the app to initialize.
title⚓︎ string x x

Sets the window title. To work properly, there should be a <title> HTML tag in the page.
top⚓︎ number 0 x

Distance of the top left window corner from the top edge of the screen in pixels.
urlLoadOptions⚓︎ LoadURLOptions x x

Options for loading the window URL. Can be used for POST requests, like uploading a file or specifying additional headers.
useRandomFrameColor⚓︎ boolean false x

If true, this will set a random frame color for the new window (from a predefined list of colors).
width⚓︎ number 400 x

Window width in pixels.
windowState⚓︎ WindowState "normal" x

If set, the window will start in the specified state ("maximized", "minimized", "normal").