WindowOptions

Defined in: window.ts:2242

Configuration for the window to create.

Since

1.0.0

Properties

allowLinkPreview?

optional allowLinkPreview: boolean

Defined in: window.ts:2426

on macOS and iOS there is a link preview on long pressing links, this is enabled by default. see https://docs.rs/objc2-web-kit/latest/objc2_web_kit/struct.WKWebView.html#method.allowsLinkPreview

---

alwaysOnBottom?

optional alwaysOnBottom: boolean

Defined in: window.ts:2299

Whether the window should always be below other windows.

---

alwaysOnTop?

optional alwaysOnTop: boolean

Defined in: window.ts:2297

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

---

backgroundColor?

optional backgroundColor: Color

Defined in: window.ts:2403

Set the window background color.

Platform-specific:

• Android / iOS: Unsupported.
• Windows: alpha channel is ignored.

Since

2.1.0

---

backgroundThrottling?

optional backgroundThrottling: BackgroundThrottlingPolicy

Defined in: window.ts:2417

Change the default background throttling behaviour.

Platform-specific

• Linux / Windows / Android: Unsupported. Workarounds like a pending WebLock transaction might suffice.
• iOS: Supported since version 17.0+.
• macOS: Supported since version 14.0+.

see https://github.com/tauri-apps/tauri/issues/5250#issuecomment-2569380578

Since

2.3.0

---

center?

optional center: boolean

Defined in: window.ts:2244

Show window in the center of the screen..

---

closable?

optional closable: boolean

Defined in: window.ts:2358

Whether the window’s native close button is enabled or not. Defaults to true.

---

contentProtected?

optional contentProtected: boolean

Defined in: window.ts:2301

Prevents the window contents from being captured by other apps.

---

decorations?

optional decorations: boolean

Defined in: window.ts:2295

Whether the window should have borders and bars or not.

---

disableInputAccessoryView?

optional disableInputAccessoryView: boolean

Defined in: window.ts:2433

Allows disabling the input accessory view on iOS.

The accessory view is the view that appears above the keyboard when a text input element is focused. It usually displays a view with “Done”, “Next” buttons.

---

focus?

optional focus: boolean

Defined in: window.ts:2283

Whether the window will be initially focused or not.

---

fullscreen?

optional fullscreen: boolean

Defined in: window.ts:2281

Whether the window is in fullscreen mode or not.

---

height?

optional height: number

Defined in: window.ts:2252

The initial height.

---

hiddenTitle?

optional hiddenTitle: boolean

Defined in: window.ts:2339

If true, sets the window title to be hidden on macOS.

---

javascriptDisabled?

optional javascriptDisabled: boolean

Defined in: window.ts:2421

Whether we should disable JavaScript code execution on the webview or not.

---

maxHeight?

optional maxHeight: number

Defined in: window.ts:2260

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

---

maximizable?

optional maximizable: boolean

Defined in: window.ts:2350

Whether the window’s native maximize button is enabled or not. Defaults to true.

---

maximized?

optional maximized: boolean

Defined in: window.ts:2291

Whether the window should be maximized upon creation or not.

---

maxWidth?

optional maxWidth: number

Defined in: window.ts:2258

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

---

minHeight?

optional minHeight: number

Defined in: window.ts:2256

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

---

minimizable?

optional minimizable: boolean

Defined in: window.ts:2354

Whether the window’s native minimize button is enabled or not. Defaults to true.

---

minWidth?

optional minWidth: number

Defined in: window.ts:2254

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

---

parent?

optional parent: string | Window | WebviewWindow

Defined in: window.ts:2372

Sets a parent to the window to be created. Can be either a Window or a label of the window.

Platform-specific

• Windows: This sets the passed parent as an owner window to the window to be created. From MSDN owned windows docs:
  • An owned window is always above its owner in the z-order.
  • The system automatically destroys an owned window when its owner is destroyed.
  • An owned window is hidden when its owner is minimized.
• Linux: This makes the new window transient for parent, see https://docs.gtk.org/gtk3/method.Window.set_transient_for.html
• macOS: This adds the window as a child of parent, see https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc

---

preventOverflow?

optional preventOverflow: boolean | PreventOverflowMargin

Defined in: window.ts:2275

Prevent the window from overflowing the working area (e.g. monitor size - taskbar size) on creation, which means the window size will be limited to monitor size - taskbar size

Can either be set to true or to a PreventOverflowMargin object to set an additional margin that should be considered to determine the working area (in this case the window size will be limited to monitor size - taskbar size - margin)

NOTE: The overflow check is only performed on window creation, resizes can still overflow

Platform-specific

• iOS / Android: Unsupported.

---

resizable?

optional resizable: boolean

Defined in: window.ts:2277

Whether the window is resizable or not.

---

shadow?

optional shadow: boolean

Defined in: window.ts:2317

Whether or not the window has shadow.

Platform-specific

• Windows:
  • false has no effect on decorated window, shadows are always ON.
  • true will make undecorated window have a 1px white border, and on Windows 11, it will have a rounded corners.
• Linux: Unsupported.

Since

2.0.0

---

skipTaskbar?

optional skipTaskbar: boolean

Defined in: window.ts:2303

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

---

tabbingIdentifier?

optional tabbingIdentifier: string

Defined in: window.ts:2346

Defines the window tabbing identifier on macOS.

Windows with the same tabbing identifier will be grouped together. If the tabbing identifier is not set, automatic tabbing will be disabled.

---

theme?

optional theme: Theme

Defined in: window.ts:2323

The initial window theme. Defaults to the system theme.

Only implemented on Windows and macOS 10.14+.

---

title?

optional title: string

Defined in: window.ts:2279

Window title.

---

titleBarStyle?

optional titleBarStyle: TitleBarStyle

Defined in: window.ts:2327

The style of the macOS title bar.

---

trafficLightPosition?

optional trafficLightPosition: LogicalPosition

Defined in: window.ts:2335

The position of the window controls on macOS.

Requires titleBarStyle: 'overlay' and decorations: true.

Since

2.4.0

---

transparent?

optional transparent: boolean

Defined in: window.ts:2289

Whether the window is transparent or not. Note that on macOS this requires the macos-private-api feature flag, enabled under tauri.conf.json > app > macOSPrivateApi. WARNING: Using private APIs on macOS prevents your application from being accepted to the App Store.

---

visible?

optional visible: boolean

Defined in: window.ts:2293

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

---

visibleOnAllWorkspaces?

optional visibleOnAllWorkspaces: boolean

Defined in: window.ts:2381

Whether the window should be visible on all workspaces or virtual desktops.

Platform-specific

• Windows / iOS / Android: Unsupported.

Since

2.0.0

---

width?

optional width: number

Defined in: window.ts:2250

The initial width.

---

windowEffects?

optional windowEffects: Effects

Defined in: window.ts:2392

Window effects.

Requires the window to be transparent.

Platform-specific:

• Windows: If using decorations or shadows, you may want to try this workaround https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891
• Linux: Unsupported

---

x?

optional x: number

Defined in: window.ts:2246

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

---

y?

optional y: number

Defined in: window.ts:2248

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