Optional
acceleratorOptional
alwaysAlways position the window at the top of the window stack.
Optional
apiConfigurations for API injection.
Optional
aspectThe 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.
Optional
autoAutomatically show the window when it is created.
Optional
autoplayAutoplay 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
.
Optional
backgroundThe 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.
Optional
contentRestrict 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.
Optional
contextOptional
cornerDefines 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.
Optional
customA field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.
Optional
customCustom headers for requests sent by the window.
Optional
defaultCenters 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.
Optional
defaultThe default height of the window. When saveWindowState
is true
, this value will be ignored for subsequent launches
in favor of the cached value.
Optional
defaultThe default left position of the window. When saveWindowState
is true
, this value will be ignored for subsequent
launches in favor of the cached value.
Optional
defaultThe default top position of the window. When saveWindowState
is true
, this value will be ignored for subsequent
launches in favor of the cached value.
Optional
defaultThe default width of the window. When saveWindowState
is true
, this value will be ignored for subsequent
launches in favor of the cached value.
Optional
frameOptional
hideHides the window instead of closing it when the close button is pressed.
Optional
iconA 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.
Optional
ignoreIgnores the cached state of the window.
Defaults the opposite value of saveWindowState
to maintain backwards compatibility.
Optional
maxThe maximum height of a window. Will default to the OS defined value if set to -1.
Optional
maxThe maximum width of a window. Will default to the OS defined value if set to -1.
Optional
maximizableAllows the window to be maximized.
Optional
minThe minimum height of the window.
Optional
minThe minimum width of the window.
Optional
minimizableAllows the window to be minimized.
Optional
opacityA 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
.
In software composition mode, the runtime flag --allow-unsafe-compositing is required.
Optional
preloadScripts that run before page load. When omitted, inherits from the parent application.
Optional
resizableA flag to allow the user to resize the window.
Optional
resizeDefines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
Optional
saveCaches the location of the window.
Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.
Optional
shadowDisplays a shadow on frameless windows.
shadow
and cornerRounding
are mutually exclusive.
On Windows 7, Aero theme is required.
Optional
showShows the window's icon in the taskbar.
Optional
smallMakes 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.
Optional
stateThe visible state of the window on creation. One of:
"maximized"
"minimized"
"normal"
Optional
taskbarSpecify 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
).
Optional
waitWhen 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.
Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.