Skip to main content

window.WindowOptions

Configuration for the window to create.

Properties#

alwaysOnTop#

Optional alwaysOnTop: boolean

Whether the window should always be on top of other windows or not.

Defined in#

window.ts:1178


center#

Optional center: boolean

Show window in the center of the screen..

Defined in#

window.ts:1144


decorations#

Optional decorations: boolean

Whether the window should have borders and bars or not.

Defined in#

window.ts:1176


focus#

Optional focus: boolean

Whether the window will be initially hidden or focused.

Defined in#

window.ts:1168


fullscreen#

Optional fullscreen: boolean

Whether the window is in fullscreen mode or not.

Defined in#

window.ts:1166


height#

Optional height: number

The initial height.

Defined in#

window.ts:1152


maxHeight#

Optional maxHeight: number

The maximum height. Only applies if maxWidth is also set.

Defined in#

window.ts:1160


maxWidth#

Optional maxWidth: number

The maximum width. Only applies if maxHeight is also set.

Defined in#

window.ts:1158


maximized#

Optional maximized: boolean

Whether the window should be maximized upon creation or not.

Defined in#

window.ts:1172


minHeight#

Optional minHeight: number

The minimum height. Only applies if minWidth is also set.

Defined in#

window.ts:1156


minWidth#

Optional minWidth: number

The minimum width. Only applies if minHeight is also set.

Defined in#

window.ts:1154


resizable#

Optional resizable: boolean

Whether the window is resizable or not.

Defined in#

window.ts:1162


skipTaskbar#

Optional skipTaskbar: boolean

Whether or not the window icon should be added to the taskbar.

Defined in#

window.ts:1180


title#

Optional title: string

Window title.

Defined in#

window.ts:1164


transparent#

Optional transparent: boolean

Whether the window is transparent or not.

Defined in#

window.ts:1170


url#

Optional url: string

Remote URL or local file path to open, e.g. https://github.com/tauri-apps or path/to/page.html.

Defined in#

window.ts:1142


visible#

Optional visible: boolean

Whether the window should be immediately visible upon creation or not.

Defined in#

window.ts:1174


width#

Optional width: number

The initial width.

Defined in#

window.ts:1150


x#

Optional x: number

The initial vertical position. Only applies if y is also set.

Defined in#

window.ts:1146


y#

Optional y: number

The initial horizontal position. Only applies if x is also set.

Defined in#

window.ts:1148