Interface LegacyWinOptionsInAppOptions

Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.

Default Value

false

Always position the window at the top of the window stack.
Copy

Configurations for API injection.

Default Value

0

The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
an aspect ratio will not be enforced.
Copy

Automatically show the window when it is created.

Autoplay policy to apply to content in the window, can be no-user-gesture-required, user-gesture-required, document-user-activation-required. Defaults to no-user-gesture-required.

The window’s backfill color as a hexadecimal value. Not to be confused with the content background color (document.body.style.backgroundColor), this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed areas when growing a window. Setting this value to the anticipated content background color can help improve user experience. Default is white.

Restrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited. See here for more details.

Deprecated

Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

Default Value

true

Show the context menu when right-clicking on the window.
Gives access to the devtools for the window.
Copy

Defines and applies rounded corners for a frameless window. NOTE: On macOS corner is not ellipse but circle rounded by the average of height and width.

A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.

Custom headers for requests sent by the window.

Centers the window in the primary monitor. This option overrides defaultLeft and defaultTop. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

NOTE: On macOS defaultCenter is somewhat above center vertically.

Default Value

500

The default height of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

Default Value

100

The default left position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

Default Value

100

The default top position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

Default Value

800

The default width of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

Default Value

true

Show the window's frame.
Copy

Default Value

false

Hides the window instead of closing it when the close button is pressed.
Copy

A URL for the icon to be shown in the window title bar and the taskbar. When omitted, inherits from the parent application.

Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.

Ignores the cached state of the window. Defaults the opposite value of saveWindowState to maintain backwards compatibility.

Default Value

-1

The maximum height of a window. Will default to the OS defined value if set to -1.
Copy

Default Value

-1

The maximum width of a window. Will default to the OS defined value if set to -1.
Copy

Default Value

true

Allows the window to be maximized.
Copy

Default Value

0

The minimum height of the window.
Copy

Default Value

true

The minimum width of the window.
Copy

Default Value

true

Allows the window to be minimized.
Copy

Default Value

1

A flag that specifies how transparent the window will be. Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there. This value is clamped between 0.0 and 1.0.

Scripts that run before page load. When omitted, inherits from the parent application.

Default Value

true

A flag to allow the user to resize the window.
Copy

Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.

Default Value

true

Caches the location of the window.

Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.

Default Value

false

Displays a shadow on frameless windows. shadow and cornerRounding are mutually exclusive. On Windows 7, Aero theme is required.

Default Value

true

Shows the window's icon in the taskbar.
Copy

Default Value

false

Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).

Note: Caveats of small windows are no Aero Snap and drag to/from maximize. Windows 10: Requires maximizable to be false. Resizing with the mouse is only possible down to 38x39 px.

Default Value

"normal"

The visible state of the window on creation. One of:

• "maximized"
• "minimized"
• "normal"

Specify a taskbar group for the window. Can be shared across applications.

If omitted from a main window, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid). Use platform.defaultWindowOptions.taskbarIconGroup to set a default for platform applications. If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).

Remarks

It's only updatable when enableJumpList is set to false.

Default Value

false

When set to true, the window will not appear until the window object's load event fires. When set to false, the window will appear immediately without waiting for content to be loaded.