AboutSupportDeveloper GuideVersion 38.126.82.64

Interface LegacyWinOptionsInAppOptions

interface LegacyWinOptionsInAppOptions {
    accelerator?: Partial<Accelerator>;
    alwaysOnTop?: boolean;
    api?: ApiSettings;
    aspectRatio?: number;
    autoShow?: boolean;
    autoplayPolicy?: AutoplayPolicyOptions;
    backgroundColor?: string;
    contentNavigation?: NavigationRules;
    contextMenu?: boolean;
    cornerRounding?: Partial<CornerRounding>;
    customData?: any;
    customRequestHeaders?: CustomRequestHeaders[];
    defaultCentered?: boolean;
    defaultHeight?: number;
    defaultLeft?: number;
    defaultTop?: number;
    defaultWidth?: number;
    frame?: boolean;
    hideOnClose?: boolean;
    icon?: string;
    ignoreSavedWindowState?: boolean;
    maxHeight?: number;
    maxWidth?: number;
    maximizable?: boolean;
    minHeight?: number;
    minWidth?: number;
    minimizable?: boolean;
    opacity?: number;
    preloadScripts?: PreloadScript[];
    resizable?: boolean;
    resizeRegion?: ResizeRegion;
    saveWindowState?: boolean;
    shadow?: boolean;
    showTaskbarIcon?: boolean;
    smallWindow?: boolean;
    state?: WindowState;
    taskbarIconGroup?: string;
    waitForPageLoad?: boolean;
}

Properties

accelerator? alwaysOnTop? api? aspectRatio? autoShow? autoplayPolicy? backgroundColor? contentNavigation? contextMenu? cornerRounding? customData? customRequestHeaders? defaultCentered? defaultHeight? defaultLeft? defaultTop? defaultWidth? frame? hideOnClose? icon? ignoreSavedWindowState? maxHeight? maxWidth? maximizable? minHeight? minWidth? minimizable? opacity? preloadScripts? resizable? resizeRegion? saveWindowState? shadow? showTaskbarIcon? smallWindow? state? taskbarIconGroup? waitForPageLoad?

Properties

Optional accelerator

accelerator?: Partial<Accelerator>

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

Optional alwaysOnTop

alwaysOnTop?: boolean

Default Value

false

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

Optional api

api?: ApiSettings

Configurations for API injection.

Optional aspectRatio

aspectRatio?: number

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.

Optional autoShow

autoShow?: boolean

Automatically show the window when it is created.

Optional autoplayPolicy

autoplayPolicy?: AutoplayPolicyOptions

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.

Optional backgroundColor

backgroundColor?: string

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.

Optional contentNavigation

contentNavigation?: NavigationRules

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.

Optional contextMenu

contextMenu?: boolean

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.

Optional cornerRounding

cornerRounding?: Partial<CornerRounding>

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.

Optional customData

customData?: any

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

Optional customRequestHeaders

customRequestHeaders?: CustomRequestHeaders[]

Custom headers for requests sent by the window.

Optional defaultCentered

defaultCentered?: boolean

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.

Optional defaultHeight

defaultHeight?: number

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.

Optional defaultLeft

defaultLeft?: number

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.

Optional defaultTop

defaultTop?: number

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.

Optional defaultWidth

defaultWidth?: number

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.

Optional frame

frame?: boolean

Default Value

true

Show the window's frame.

Optional hideOnClose

hideOnClose?: boolean

Default Value

false

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

Optional icon

icon?: string

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.

Optional ignoreSavedWindowState

ignoreSavedWindowState?: boolean

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

Optional maxHeight

maxHeight?: number

Default Value

-1

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

Optional maxWidth

maxWidth?: number

Default Value

-1

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

Optional maximizable

maximizable?: boolean

Default Value

true

Allows the window to be maximized.

Optional minHeight

minHeight?: number

Default Value

0

The minimum height of the window.

Optional minWidth

minWidth?: number

Default Value

true

The minimum width of the window.

Optional minimizable

minimizable?: boolean

Default Value

true

Allows the window to be minimized.

Optional opacity

opacity?: number

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.

Optional preloadScripts

preloadScripts?: PreloadScript[]

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

Optional resizable

resizable?: boolean

Default Value

true

A flag to allow the user to resize the window.

Optional resizeRegion

resizeRegion?: ResizeRegion

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

Optional saveWindowState

saveWindowState?: boolean

Default Value

true

Caches the location of the window.

Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.

Optional shadow

shadow?: boolean

Default Value

false

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

Optional showTaskbarIcon

showTaskbarIcon?: boolean

Default Value

true

Shows the window's icon in the taskbar.

Optional smallWindow

smallWindow?: boolean

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.

Optional state

state?: WindowState

Default Value

"normal"

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

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

Optional taskbarIconGroup

taskbarIconGroup?: string

Specify a taskbar group for the window. If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).

Optional waitForPageLoad

waitForPageLoad?: boolean

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.

Settings

Theme

On This Page

acceleratoralwaysOnTopapiaspectRatioautoShowautoplayPolicybackgroundColorcontentNavigationcontextMenucornerRoundingcustomDatacustomRequestHeadersdefaultCentereddefaultHeightdefaultLeftdefaultTopdefaultWidthframehideOnCloseiconignoreSavedWindowStatemaxHeightmaxWidthmaximizableminHeightminWidthminimizableopacitypreloadScriptsresizableresizeRegionsaveWindowStateshadowshowTaskbarIconsmallWindowstatetaskbarIconGroupwaitForPageLoad