跳到内容
Tauri
指南 参考 博客 发布

window

提供创建窗口、与其他窗口通信以及操作当前窗口的API。

窗口事件

标题为“窗口事件”的章节

可以使用Window.listen监听事件

import { getCurrentWindow } from "@tauri-apps/api/window";
getCurrentWindow().listen("my-window-event", ({ event, payload }) => { });

参考

标题为“引用”的章节

颜色

标题为“颜色”的章节

重新导出颜色

拖放事件

标题为“DragDropEvent”的章节

重新导出DragDropEvent

逻辑位置

标题为“LogicalPosition”的章节

重新导出LogicalPosition

逻辑大小

标题为“LogicalSize”的章节

重新导出LogicalSize

物理位置

标题为“PhysicalPosition”的章节

重新导出PhysicalPosition

物理大小

标题为“PhysicalSize”的章节

重新导出PhysicalSize

枚举

标题为“枚举”的章节

后台节流策略

标题为“BackgroundThrottlingPolicy”的章节

后台节流策略

始于

标题为“自”的章节

2.0.0

枚举成员

标题为“枚举成员”的章节

禁用
标题为“禁用”的章节
Disabled: "disabled";

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2091

暂停
标题为“暂停”的章节
Suspend: "suspend";

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2093

节流
标题为“节流”的章节
Throttle: "throttle";

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2092

效果

标题为“效果”的章节

平台特定窗口效果

始于

标题为“自”的章节

2.0.0

枚举成员

标题为“枚举成员”的章节

亚克力
标题为“亚克力”的章节
Acrylic: "acrylic";

Windows 10/11

备注

标题为“备注”的章节

在Windows 10 v1903+和Windows 11 build 22000上调整窗口大小/拖动窗口时，此效果性能不佳。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2207

基于外观
标题为“AppearanceBased”的章节
AppearanceBased: "appearanceBased";

适合视图有效外观的默认材质。macOS 10.14-

已弃用
标题为“已弃用”的章节

自macOS 10.14以来。您应该改为选择适当的语义材质。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2107

模糊
标题为“模糊”的章节
Blur: "blur";

仅限Windows 7/10/11(22H1)

备注

标题为“备注”的章节

在Windows 11 build 22621上调整窗口大小/拖动窗口时，此效果性能不佳。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2199

内容背景
标题为“内容背景”的章节
ContentBackground: "contentBackground";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2179

深色
标题为“深色”的章节
Dark: "dark";

macOS 10.14-

已弃用
标题为“已弃用”的章节

自macOS 10.14以来。请改用语义材质。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2119

全屏UI
标题为“FullScreenUI”的章节
FullScreenUI: "fullScreenUI";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2171

HeaderView
标题为“HeaderView”的章节
HeaderView: "headerView";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2155

HudWindow
标题为“HudWindow”的章节
HudWindow: "hudWindow";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2167

浅色
标题为“浅色”的章节
Light: "light";

macOS 10.14-

已弃用
标题为“已弃用”的章节

自macOS 10.14以来。请改用语义材质。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2113

中浅色
标题为“MediumLight”的章节
MediumLight: "mediumLight";

macOS 10.14-

已弃用
标题为“已弃用”的章节

自macOS 10.14以来。请改用语义材质。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2125

标题为“菜单”的章节
Menu: "menu";

macOS 10.11+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2143

云母
标题为“Mica”的章节
Mica: "mica";

仅限Windows 11

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2191

弹出框
标题为“Popover”的章节
Popover: "popover";

macOS 10.11+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2147

选择
标题为“选择”的章节
Selection: "selection";

macOS 10.10+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2139

表单
标题为“表单”的章节
Sheet: "sheet";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2159

标题为“侧边栏”的章节
Sidebar: "sidebar";

macOS 10.11+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2151

选项卡式
标题为“选项卡式”的章节
Tabbed: "tabbed";

与系统暗色偏好匹配的选项卡效果 仅限Windows 11

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2211

选项卡式深色
标题为“选项卡式深色”的章节
TabbedDark: "tabbedDark";

在暗色模式下启用的选项卡效果，但仅在系统启用了暗色模式时 仅限Windows 11

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2215

选项卡式浅色
标题为“选项卡式浅色”的章节
TabbedLight: "tabbedLight";

浅色模式下的选项卡效果 仅限Windows 11

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2219

标题栏
标题为“标题栏”的章节
Titlebar: "titlebar";

macOS 10.10+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2135

工具提示
标题为“工具提示”的章节
Tooltip: "tooltip";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2175

超深色
标题为“UltraDark”的章节
UltraDark: "ultraDark";

macOS 10.14-

已弃用
标题为“已弃用”的章节

自macOS 10.14以来。请改用语义材质。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2131

页面背景下方
标题为“UnderPageBackground”的章节
UnderPageBackground: "underPageBackground";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2187

窗口背景下方
标题为“UnderWindowBackground”的章节
UnderWindowBackground: "underWindowBackground";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2183

窗口背景
标题为“WindowBackground”的章节
WindowBackground: "windowBackground";

macOS 10.14+

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2163

效果状态

标题为“EffectState”的章节

窗口效果状态 仅限macOS

查看

标题为“查看”的章节

https://developer.apple.com/documentation/appkit/nsvisualeffectview/state

始于

标题为“自”的章节

2.0.0

枚举成员

标题为“枚举成员”的章节

活动
标题为“活动”的章节
Active: "active";

使窗口效果状态始终处于活动状态 仅限macOS

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2237

跟随窗口活动状态
标题为“FollowsWindowActiveState”的章节
FollowsWindowActiveState: "followsWindowActiveState";

使窗口效果状态跟随窗口的活动状态 仅限macOS

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2233

非活动
标题为“非活动”的章节
Inactive: "inactive";

使窗口效果状态始终处于非活动状态 仅限macOS

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2241

进度条状态

标题为“ProgressBarStatus”的章节

枚举成员

标题为“枚举成员”的章节

错误
标题为“错误”的章节
Error: "error";

错误状态。在Linux上被视为正常

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L190

不确定
标题为“不确定”的章节
Indeterminate: "indeterminate";

不确定状态。在Linux和macOS上被视为正常

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L182

无
标题为“无”的章节
None: "none";

隐藏进度条。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L174

正常
标题为“正常”的章节
Normal: "normal";

正常状态。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L178

暂停
标题为“暂停”的章节
Paused: "paused";

暂停状态。在Linux上被视为正常

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L186

用户注意类型

标题为“UserAttentionType”的章节

请求窗口注意的类型。

始于

标题为“自”的章节

1.0.0

枚举成员

标题为“枚举成员”的章节

关键
标题为“关键”的章节
Critical: 1;

平台特定

  • macOS: 使停靠栏图标弹跳，直到应用程序获得焦点。
  • Windows: 闪烁窗口和任务栏按钮，直到应用程序获得焦点。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L99

信息
标题为“信息”的章节
Informational: 2;

平台特定

  • macOS: 停靠栏图标弹跳一次。
  • Windows: 任务栏按钮闪烁，直到应用程序获得焦点。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L105

类

标题为“类”的章节

关闭请求事件

标题为“CloseRequestedEvent”的章节

构造函数

构造函数

new CloseRequestedEvent()
标题为“new CloseRequestedEvent()”的部分
new CloseRequestedEvent(event): CloseRequestedEvent
参数
参数
参数类型
eventEvent<未知>
返回
返回

关闭请求事件

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L115

属性

属性
属性类型描述定义于
事件EventName事件名称源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L110
id数字用于取消监听的事件标识符源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L112

方法

方法

isPreventDefault()
标题为“isPreventDefault()”的部分
isPreventDefault(): boolean
返回
返回

布尔值 (boolean)

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L124

preventDefault()
标题为“preventDefault()”的部分
preventDefault(): void
返回
返回

空

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L120

窗口

窗口

创建新窗口或获取现有窗口的句柄。

窗口由一个*标签*（一个用于后续引用的唯一标识符）标识。它只能包含字母数字字符 a-zA-Z 以及以下特殊字符 -、/、: 和 _。

示例

示例
import { Window } from "@tauri-apps/api/window"


const appWindow = new Window('theUniqueLabel');


appWindow.once('tauri://created', function () {
 // window successfully created
});
appWindow.once('tauri://error', function (e) {
 // an error happened creating the window
});


// emit an event to the backend
await appWindow.emit("some-event", "data");
// listen to an event from the backend
const unlisten = await appWindow.listen("event-name", e => {});
unlisten();

始于

标题为“自”的章节

2.0.0

扩展自

由...扩展

构造函数

构造函数

new Window()
标题为“new Window()”的部分
new Window(label, options): Window

创建一个新窗口。

参数
参数
参数类型描述
标签字符串唯一的窗口标签。必须是字母数字：a-zA-Z-/:_。
选项窗口选项-
返回
返回

窗口

与窗口通信的 Window 实例。

示例
示例
import { Window } from '@tauri-apps/api/window';
const appWindow = new Window('my-label');
appWindow.once('tauri://created', function () {
 // window successfully created
});
appWindow.once('tauri://error', function (e) {
 // an error happened creating the window
});

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L298

属性

属性
属性类型描述定义于
标签字符串窗口标签。它是窗口的唯一标识符，可用于后续引用。源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L276
监听器Record<字符串, EventCallback<任意>[]>本地事件监听器。源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L279

方法

方法

center()
标题为“center()”的部分
center(): Promise<void>

将窗口居中。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().center();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L835

clearEffects()
标题为“clearEffects()”的部分
clearEffects(): Promise<void>

如果可能，清除任何应用的特效。

返回
返回

Promise<void>

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1223

close()
标题为“close()”的部分
close(): Promise<void>

关闭窗口。

请注意，这将触发一个 closeRequested 事件，因此您可以拦截它。要强制关闭窗口，请使用 Window.destroy。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().close();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1144

destroy()
标题为“destroy()”的部分
destroy(): Promise<void>

销毁窗口。行为类似于 Window.close，但强制关闭窗口而不是发出 closeRequested 事件。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().destroy();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1160

emit()
标题为“emit()”的部分
emit<T>(event, payload?): Promise<void>

向所有 目标 发出事件。

类型参数
类型参数
类型参数
T
参数
参数
参数类型描述
event字符串事件名称。必须只包含字母数字字符、-、/、: 和 _。
载荷 (payload)?T事件载荷。
返回
返回

Promise<void>

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().emit('window-loaded', { loggedIn: true, token: 'authToken' });

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L449

emitTo()
标题为“emitTo()”的部分
emitTo<T>(
   target,
   event,
payload?): Promise<void>

向所有与给定目标匹配的 目标 发出事件。

类型参数
类型参数
类型参数
T
参数
参数
参数类型描述
目标字符串 | EventTarget目标窗口/WebView/WebviewWindow 的标签，或原始 EventTarget 对象。
event字符串事件名称。必须只包含字母数字字符、-、/、: 和 _。
载荷 (payload)?T事件载荷。
返回
返回

Promise<void>

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().emit('main', 'window-loaded', { loggedIn: true, token: 'authToken' });

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L476

hide()
标题为“hide()”的部分
hide(): Promise<void>

将窗口可见性设置为 false。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().hide();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1126

innerPosition()
标题为“innerPosition()”的部分
innerPosition(): Promise<PhysicalPosition>

窗口客户区左上角相对于桌面左上角的位置。

返回
返回

Promise<PhysicalPosition>

窗口的内部位置。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const position = await getCurrentWindow().innerPosition();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L537

innerSize()
标题为“innerSize()”的部分
innerSize(): Promise<PhysicalSize>

窗口客户区的物理大小。客户区是窗口的内容，不包括标题栏和边框。

返回
返回

Promise<PhysicalSize>

窗口的内部大小。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const size = await getCurrentWindow().innerSize();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L570

isAlwaysOnTop()
标题为“isAlwaysOnTop()”的部分
isAlwaysOnTop(): Promise<boolean>

窗口是否配置为始终位于其他窗口之上。

返回
返回

Promise<布尔值>

窗口是否可见。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const alwaysOnTop = await getCurrentWindow().isAlwaysOnTop();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L817

isClosable()
标题为“isClosable()”的部分
isClosable(): Promise<boolean>

获取窗口的本地关闭按钮状态。

平台特定

  • iOS / Android: 不支持。
返回
返回

Promise<布尔值>

窗口的原生关闭按钮是否启用。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const closable = await getCurrentWindow().isClosable();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L750

isDecorated()
标题为“isDecorated()”的部分
isDecorated(): Promise<boolean>

获取窗口当前的装饰状态。

返回
返回

Promise<布尔值>

窗口是否被装饰。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const decorated = await getCurrentWindow().isDecorated();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L671

isEnabled()
标题为“isEnabled()”的部分
isEnabled(): Promise<boolean>

窗口是否启用或禁用。

返回
返回

Promise<布尔值>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setEnabled(false);
始于
标题为“自”的章节

2.0.0

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L927

isFocused()
标题为“isFocused()”的部分
isFocused(): Promise<boolean>

获取窗口当前的焦点状态。

返回
返回

Promise<布尔值>

窗口是否获得焦点。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const focused = await getCurrentWindow().isFocused();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L655

isFullscreen()
标题为“isFullscreen()”的部分
isFullscreen(): Promise<boolean>

获取窗口当前的满屏状态。

返回
返回

Promise<布尔值>

窗口是否处于全屏模式。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const fullscreen = await getCurrentWindow().isFullscreen();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L609

isMaximizable()
标题为“isMaximizable()”的部分
isMaximizable(): Promise<boolean>

获取窗口的本地最大化按钮状态。

平台特定

  • Linux / iOS / Android： 不支持。
返回
返回

Promise<布尔值>

窗口的本地最大化按钮是否启用。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const maximizable = await getCurrentWindow().isMaximizable();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L708

isMaximized()
标题为“isMaximized()”的部分
isMaximized(): Promise<boolean>

获取窗口当前的最大化状态。

返回
返回

Promise<布尔值>

窗口是否最大化。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const maximized = await getCurrentWindow().isMaximized();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L639

isMinimizable()
标题为“isMinimizable()”的部分
isMinimizable(): Promise<boolean>

获取窗口的本地最小化按钮状态。

平台特定

  • Linux / iOS / Android： 不支持。
返回
返回

Promise<布尔值>

窗口的原生最小化按钮是否启用。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const minimizable = await getCurrentWindow().isMinimizable();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L729

isMinimized()
标题为“isMinimized()”的部分
isMinimized(): Promise<boolean>

获取窗口当前的最小化状态。

返回
返回

Promise<布尔值>

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const minimized = await getCurrentWindow().isMinimized();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L623

isResizable()
标题为“isResizable()”的部分
isResizable(): Promise<boolean>

获取窗口当前的尺寸可调整状态。

返回
返回

Promise<布尔值>

窗口是否可调整大小。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const resizable = await getCurrentWindow().isResizable();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L687

isVisible()
标题为“isVisible()”的部分
isVisible(): Promise<boolean>

获取窗口当前的可见状态。

返回
返回

Promise<布尔值>

窗口是否可见。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const visible = await getCurrentWindow().isVisible();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L766

listen()
标题为“listen()”的部分
listen<T>(event, handler): Promise<UnlistenFn>

监听此窗口发出的事件。

类型参数
类型参数
类型参数
T
参数
参数
参数类型描述
eventEventName事件名称。必须只包含字母数字字符、-、/、: 和 _。
处理程序EventCallback<T>事件处理程序。
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const unlisten = await getCurrentWindow().listen<string>('state-changed', (event) => {
  console.log(`Got error: ${payload}`);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L387

maximize()
标题为“maximize()”的部分
maximize(): Promise<void>

最大化窗口。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().maximize();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1030

minimize()
标题为“minimize()”的部分
minimize(): Promise<void>

最小化窗口。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().minimize();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1078

onCloseRequested()
标题为“onCloseRequested()”的部分
onCloseRequested(handler): Promise<UnlistenFn>

监听窗口关闭请求。当用户请求关闭窗口时发出。

参数
参数
参数类型
处理程序(事件) => void | Promise<void>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
import { confirm } from '@tauri-apps/api/dialog';
const unlisten = await getCurrentWindow().onCloseRequested(async (event) => {
  const confirmed = await confirm('Are you sure?');
  if (!confirmed) {
    // user did not confirm closing the window; let's prevent it
    event.preventDefault();
  }
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1885

onDragDropEvent()
标题为“onDragDropEvent()”的部分
onDragDropEvent(handler): Promise<UnlistenFn>

监听文件拖放事件。当用户将选定的文件悬停在 webview 上、拖放文件或取消操作时，会触发监听器。

参数
参数
参数类型
处理程序EventCallback<DragDropEvent>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/webview";
const unlisten = await getCurrentWindow().onDragDropEvent((event) => {
 if (event.payload.type === 'over') {
   console.log('User hovering', event.payload.position);
 } else if (event.payload.type === 'drop') {
   console.log('User dropped', event.payload.paths);
 } else {
   console.log('File drop cancelled');
 }
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1923

onFocusChanged()
标题为“onFocusChanged()”的部分
onFocusChanged(handler): Promise<UnlistenFn>

监听窗口焦点变化。

参数
参数
参数类型
处理程序EventCallback<布尔值>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onFocusChanged(({ payload: focused }) => {
 console.log('Focus changed, window is focused? ' + focused);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2001

onMoved()
标题为“onMoved()”的部分
onMoved(handler): Promise<UnlistenFn>

监听窗口移动。

参数
参数
参数类型
处理程序EventCallback<PhysicalPosition>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onMoved(({ payload: position }) => {
 console.log('Window moved', position);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1856

onResized()
标题为“onResized()”的部分
onResized(handler): Promise<UnlistenFn>

监听窗口大小调整。

参数
参数
参数类型
处理程序EventCallback<PhysicalSize>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onResized(({ payload: size }) => {
 console.log('Window resized', size);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1832

onScaleChanged()
标题为“onScaleChanged()”的部分
onScaleChanged(handler): Promise<UnlistenFn>

监听窗口比例尺变化。当窗口的比例因子发生变化时发出。以下用户操作可能导致 DPI 变化

  • 更改显示器分辨率。
  • 更改显示器比例因子（例如在 Windows 控制面板中）。
  • 将窗口移动到具有不同比例因子的显示器。
参数
参数
参数类型
处理程序EventCallback<ScaleFactorChanged>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onScaleChanged(({ payload }) => {
 console.log('Scale changed', payload.scaleFactor, payload.size);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2041

onThemeChanged()
标题为“onThemeChanged()”的部分
onThemeChanged(handler): Promise<UnlistenFn>

监听系统主题变化。

参数
参数
参数类型
处理程序EventCallback<Theme>
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onThemeChanged(({ payload: theme }) => {
 console.log('New theme: ' + theme);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2067

once()
标题为“once()”的部分
once<T>(event, handler): Promise<UnlistenFn>

只监听此窗口发出的事件一次。

类型参数
类型参数
类型参数
T
参数
参数
参数类型描述
eventEventName事件名称。必须只包含字母数字字符、-、/、: 和 _。
处理程序EventCallback<T>事件处理程序。
返回
返回

Promise<UnlistenFn>

一个解析为取消监听事件函数的 Promise。请注意，如果您的监听器超出范围（例如组件已卸载），则必须删除该监听器。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const unlisten = await getCurrentWindow().once<null>('initialized', (event) => {
  console.log(`Window initialized!`);
});


// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L422

outerPosition()
标题为“outerPosition()”的部分
outerPosition(): Promise<PhysicalPosition>

窗口左上角相对于桌面左上角的位置。

返回
返回

Promise<PhysicalPosition>

窗口的外部位置。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const position = await getCurrentWindow().outerPosition();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L553

outerSize()
标题为“outerSize()”的部分
outerSize(): Promise<PhysicalSize>

整个窗口的物理大小。这些尺寸包括标题栏和边框。如果你不想要这些（通常也不需要），请使用 inner_size。

返回
返回

Promise<PhysicalSize>

窗口的外部大小。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const size = await getCurrentWindow().outerSize();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L590

requestUserAttention()
标题为“requestUserAttention()”的部分
requestUserAttention(requestType): Promise<void>

请求用户注意窗口，如果应用程序已获得焦点，则此操作无效。请求用户注意的表现形式因平台而异，详情请参阅 UserAttentionType。

提供 null 将取消用户注意请求。当窗口接收输入时，窗口管理器可能不会自动取消用户注意请求。

平台特定

  • macOS: null 无效。
  • Linux: 紧急程度具有相同的效果。
参数
参数
参数类型
requestTypenull | UserAttentionType
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().requestUserAttention();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L861

scaleFactor()
标题为“scaleFactor()”的部分
scaleFactor(): Promise<number>

可用于将物理像素映射到逻辑像素的比例因子。

返回
返回

Promise<数字>

窗口的显示器比例因子。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const factor = await getCurrentWindow().scaleFactor();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L521

setAlwaysOnBottom()
标题为“setAlwaysOnBottom()”的部分
setAlwaysOnBottom(alwaysOnBottom): Promise<void>

窗口是否应始终位于其他窗口下方。

参数
参数
参数类型描述
始终在底部布尔值 (boolean)窗口是否应始终位于其他窗口之下。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setAlwaysOnBottom(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1259

setAlwaysOnTop()
标题为“setAlwaysOnTop()”的部分
setAlwaysOnTop(alwaysOnTop): Promise<void>

窗口是否应始终位于其他窗口之上。

参数
参数
参数类型描述
始终在最顶层布尔值 (boolean)窗口是否应始终位于其他窗口之上。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setAlwaysOnTop(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1241

setBackgroundColor()
标题为“setBackgroundColor()”的部分
setBackgroundColor(color): Promise<void>

设置窗口背景颜色。

平台特定

  • Windows: alpha 通道被忽略。
  • iOS / Android: 不支持。
参数
参数
参数类型
颜色颜色
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

始于
标题为“自”的章节

2.1.0

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1593

setBadgeCount()
标题为“setBadgeCount()”的部分
setBadgeCount(count?): Promise<void>

设置徽章计数。它是应用程序范围的，不特定于此窗口。

平台特定

  • Windows: 不支持。请改用 @{linkcode Window.setOverlayIcon}。
参数
参数
参数类型描述
计数?数字徽章计数。使用 undefined 删除徽章。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setBadgeCount(5);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1685

setBadgeLabel()
标题为“setBadgeLabel()”的部分
setBadgeLabel(label?): Promise<void>

设置徽章标签 仅限 macOS。

参数
参数
参数类型描述
标签?字符串徽章标签。使用 undefined 删除徽章。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setBadgeLabel("Hello");

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1704

setClosable()
标题为“setClosable()”的部分
setClosable(closable): Promise<void>

设置窗口的本地关闭按钮是否启用。

平台特定

  • Linux: GTK+ 将尽力说服窗口管理器不显示关闭按钮。根据系统，此功能在已可见的窗口上调用时可能无效。
  • iOS / Android: 不支持。
参数
参数
参数类型
可关闭布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setClosable(false);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L995

setContentProtected()
标题为“setContentProtected()”的部分
setContentProtected(protected_): Promise<void>

防止窗口内容被其他应用程序捕获。

参数
参数
参数类型
protected_布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setContentProtected(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1276

setCursorGrab()
标题为“setCursorGrab()”的部分
setCursorGrab(grab): Promise<void>

抓取光标，阻止其离开窗口。

不保证光标会被隐藏。如果需要，应自行隐藏。

平台特定

  • Linux： 不支持。
  • macOS: 这会将光标锁定在一个固定位置，这在视觉上看起来很笨拙。
参数
参数
参数类型描述
抓取布尔值 (boolean)true 抓取光标图标，false 释放光标图标。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setCursorGrab(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1532

setCursorIcon()
标题为“setCursorIcon()”的部分
setCursorIcon(icon): Promise<void>

修改窗口的光标图标。

参数
参数
参数类型描述
图标光标图标新光标图标。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setCursorIcon('help');

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1574

setCursorPosition()
标题为“setCursorPosition()”的部分
setCursorPosition(position): Promise<void>

更改光标在窗口坐标中的位置。

参数
参数
参数类型描述
位置逻辑位置 | 物理位置 | 位置新光标位置。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';
await getCurrentWindow().setCursorPosition(new LogicalPosition(600, 300));

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1608

setCursorVisible()
标题为“setCursorVisible()”的部分
setCursorVisible(visible): Promise<void>

修改光标的可见性。

平台特定

  • Windows: 光标仅在窗口范围内隐藏。
  • macOS: 只要窗口具有输入焦点，光标就会隐藏，即使光标在窗口外部也是如此。
参数
参数
参数类型描述
可见的布尔值 (boolean)如果为 false，则隐藏光标。如果为 true，则显示光标。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setCursorVisible(false);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1556

setDecorations()
标题为“setDecorations()”的部分
setDecorations(decorations): Promise<void>

窗口是否应该有边框和标题栏。

参数
参数
参数类型描述
装饰布尔值 (boolean)窗口是否应该有边框和标题栏。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setDecorations(false);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1177

setEffects()
标题为“setEffects()”的部分
setEffects(effects): Promise<void>

设置窗口效果。

参数
参数
参数类型
效果效果
返回
返回

Promise<void>

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1213

setEnabled()
标题为“setEnabled()”的部分
setEnabled(enabled): Promise<void>

启用或禁用窗口。

参数
参数
参数类型
已启用布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setEnabled(false);
始于
标题为“自”的章节

2.0.0

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L908

setFocus()
标题为“setFocus()”的部分
setFocus(): Promise<void>

将窗口置于最前端并聚焦。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setFocus();

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1434

setFocusable()
标题为“setFocusable()”的部分
setFocusable(focusable): Promise<void>

设置窗口是否可聚焦。

平台特定

  • macOS：如果窗口已获得焦点，则在调用 set_focusable(false) 后无法取消其焦点。在这种情况下，您可以考虑调用 Window.setFocus，但这会将窗口移动到背面，即在 z 轴顺序上置于底部。
参数
参数
参数类型描述
可聚焦布尔值 (boolean)窗口是否可聚焦。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setFocusable(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1457

setFullscreen()
标题为“setFullscreen()”的部分
setFullscreen(fullscreen): Promise<void>

设置窗口全屏状态。

参数
参数
参数类型描述
全屏布尔值 (boolean)窗口是否应全屏显示。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setFullscreen(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1401

setIcon()
标题为“setIcon()”的部分
setIcon(icon): Promise<void>

设置窗口图标。

参数
参数
参数类型描述
图标| 字符串 | Uint8Array | 数字[] | ArrayBuffer | Image图标字节或图标文件路径。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setIcon('/tauri/awesome.png');

请注意，您可能需要 image-ico 或 image-png Cargo 功能才能使用此 API。要启用它，请更改您的 Cargo.toml 文件

[dependencies]
tauri = { version = "...", features = ["...", "image-png"] }

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1482

setIgnoreCursorEvents()
标题为“setIgnoreCursorEvents()”的部分
setIgnoreCursorEvents(ignore): Promise<void>

更改光标事件行为。

参数
参数
参数类型描述
忽略布尔值 (boolean)true 忽略光标事件；false 照常处理它们。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setIgnoreCursorEvents(true);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1629

setMaxSize()
标题为“setMaxSize()”的部分
setMaxSize(size): Promise<void>

设置窗口最大内部大小。如果 size 参数未定义，则取消约束。

参数
参数
参数类型描述
尺寸| 未定义 | null | 逻辑尺寸 | 物理尺寸 | 尺寸逻辑或物理内部大小，或 null 以取消约束。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';
await getCurrentWindow().setMaxSize(new LogicalSize(600, 500));

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1332

setMaximizable()
标题为“setMaximizable()”的部分
setMaximizable(maximizable): Promise<void>

设置窗口的本地最大化按钮是否启用。如果resizable设置为false，则此设置将被忽略。

平台特定

  • macOS： 禁用窗口标题栏中的“缩放”按钮，该按钮也用于进入全屏模式。
  • Linux / iOS / Android： 不支持。
参数
参数
参数类型
可最大化布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setMaximizable(false);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L950

setMinSize()
标题为“setMinSize()”的部分
setMinSize(size): Promise<void>

设置窗口最小内部大小。如果未提供 size 参数，则取消约束。

参数
参数
参数类型描述
尺寸| 未定义 | null | 逻辑尺寸 | 物理尺寸 | 尺寸逻辑或物理内部大小，或 null 以取消约束。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, PhysicalSize } from '@tauri-apps/api/window';
await getCurrentWindow().setMinSize(new PhysicalSize(600, 500));

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1312

setMinimizable()
标题为“setMinimizable()”的部分
setMinimizable(minimizable): Promise<void>

设置窗口的本地最小化按钮是否启用。

平台特定

  • Linux / iOS / Android： 不支持。
参数
参数
参数类型
可最小化布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setMinimizable(false);

源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L972

setOverlayIcon()
标题为“setOverlayIcon()”的章节
setOverlayIcon(icon?): Promise<void>

设置覆盖图标。仅限 Windows，可为每个窗口设置覆盖图标。

请注意，您可能需要 image-ico 或 image-png Cargo 功能才能使用此 API。要启用它，请更改您的 Cargo.toml 文件

[dependencies]
tauri = { version = "...", features = ["...", "image-png"] }
参数
参数
参数类型描述
图标?| 字符串 | Uint8Array | 数字[] | ArrayBuffer | Image图标字节或图标文件的路径。使用 undefined 可删除覆盖图标。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setOverlayIcon("/tauri/awesome.png");

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1733

setPosition()
标题为“setPosition()”的章节
setPosition(position): Promise<void>

设置窗口外部位置。

参数
参数
参数类型描述
位置逻辑位置 | 物理位置 | 位置新位置，以逻辑像素或物理像素表示。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';
await getCurrentWindow().setPosition(new LogicalPosition(600, 500));

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1381

setProgressBar()
标题为“setProgressBar()”的章节
setProgressBar(state): Promise<void>

设置任务栏进度状态。

平台特定

  • Linux / macOS：进度条是应用范围的，不特定于此窗口。
  • Linux：仅支持带有 libunity 的桌面环境（例如 GNOME）。
参数
参数
参数类型
状态进度条状态
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, ProgressBarStatus } from '@tauri-apps/api/window';
await getCurrentWindow().setProgressBar({
  status: ProgressBarStatus.Normal,
  progress: 50,
});

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1761

setResizable()
标题为“setResizable()”的章节
setResizable(resizable): Promise<void>

更新窗口可调整大小的标志。

参数
参数
参数类型
可调整大小布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setResizable(false);

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L889

setShadow()
标题为“setShadow()”的章节
setShadow(enable): Promise<void>

窗口是否应该有阴影。

平台特定

  • Windows
    • false 对装饰窗口无效，阴影始终开启。
    • true 将使无装饰窗口有 1 像素的白色边框，在 Windows 11 上，它将有圆角。
  • Linux： 不支持。
参数
参数
参数类型
启用布尔值 (boolean)
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setShadow(false);

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1203

setSimpleFullscreen()
标题为“setSimpleFullscreen()”的章节
setSimpleFullscreen(fullscreen): Promise<void>

在 macOS 上，切换到不需要新 macOS 空间的全屏模式。返回一个布尔值，指示转换是否成功（如果窗口已处于原生全屏模式，则此操作无效）。这是 macOS 在 Lion 之前版本中全屏的工作方式。它允许用户拥有全屏窗口，而无需使用另一个空间或控制整个显示器。

在其他平台上，这与 Window.setFullscreen 相同。

参数
参数
参数类型描述
全屏布尔值 (boolean)窗口是否应该进入简单全屏模式。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1417

setSize()
标题为“setSize()”的章节
setSize(size): Promise<void>

使用新的内部尺寸调整窗口大小。

参数
参数
参数类型描述
尺寸LogicalSize | PhysicalSize | Size逻辑或物理内部尺寸。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';
await getCurrentWindow().setSize(new LogicalSize(600, 500));

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1294

setSizeConstraints()
标题为“setSizeConstraints()”的章节
setSizeConstraints(constraints): Promise<void>

设置窗口内部尺寸约束。

参数
参数
参数类型描述
约束undefined | null | WindowSizeConstraints逻辑或物理内部大小，或 null 以取消约束。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setSizeConstraints({ minWidth: 300 });

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1352

setSkipTaskbar()
标题为“setSkipTaskbar()”的章节
setSkipTaskbar(skip): Promise<void>

窗口图标是否应从任务栏隐藏。

平台特定

  • macOS： 不支持。
参数
参数
参数类型描述
跳过布尔值 (boolean)设置为 true 以隐藏窗口图标，设置为 false 以显示它。
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setSkipTaskbar(true);

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1506

setTheme()
标题为“setTheme()”的章节
setTheme(theme?): Promise<void>

设置窗口主题，传入 null 或 undefined 以跟随系统主题

平台特定

  • Linux / macOS：主题是应用范围的，不特定于此窗口。
  • iOS / Android: 不支持。
参数
参数
参数类型
主题?null | Theme
返回
返回

Promise<void>

始于
标题为“自”的章节

2.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1806

setTitle()
标题为“setTitle()”的章节
setTitle(title): Promise<void>

设置窗口标题。

参数
参数
参数类型描述
标题字符串新标题
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setTitle('Tauri');

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1013

setTitleBarStyle()
标题为“setTitleBarStyle()”的章节
setTitleBarStyle(style): Promise<void>

设置标题栏样式。仅限 macOS。

参数
参数
参数类型
样式标题栏样式
返回
返回

Promise<void>

始于
标题为“自”的章节

2.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1789

setVisibleOnAllWorkspaces()
标题为“setVisibleOnAllWorkspaces()”的章节
setVisibleOnAllWorkspaces(visible): Promise<void>

设置窗口是否应在所有工作区或虚拟桌面上可见。

平台特定

  • Windows / iOS / Android： 不支持。
参数
参数
参数类型
可见的布尔值 (boolean)
返回
返回

Promise<void>

始于
标题为“自”的章节

2.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1777

show()
标题为“show()”的章节
show(): Promise<void>

将窗口可见性设置为 true。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().show();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1110

startDragging()
标题为“startDragging()”的章节
startDragging(): Promise<void>

开始拖动窗口。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().startDragging();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1646

startResizeDragging()
标题为“startResizeDragging()”的章节
startResizeDragging(direction): Promise<void>

开始调整窗口大小拖动。

参数
参数
参数类型
方向ResizeDirection
返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().startResizeDragging();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1662

theme()
标题为“theme()”的章节
theme(): Promise<null | Theme>

获取窗口当前主题。

平台特定

  • macOS： 主题在 macOS 10.14 中引入。在 macOS 10.13 及更低版本上返回 light。
返回
返回

Promise<null | Theme>

窗口主题。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const theme = await getCurrentWindow().theme();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L801

title()
标题为“title()”的章节
title(): Promise<string>

获取窗口当前标题。

返回
返回

Promise<string>

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
const title = await getCurrentWindow().title();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L780

toggleMaximize()
标题为“toggleMaximize()”的章节
toggleMaximize(): Promise<void>

切换窗口最大化状态。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().toggleMaximize();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1062

unmaximize()
标题为“unmaximize()”的章节
unmaximize(): Promise<void>

取消窗口最大化。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().unmaximize();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1046

unminimize()
标题为“unminimize()”的章节
unminimize(): Promise<void>

取消窗口最小化。

返回
返回

Promise<void>

表示操作成功或失败的 Promise。

示例
示例
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().unminimize();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1094

getAll()
标题为“getAll()”的章节
static getAll(): Promise<Window[]>

获取所有可用窗口的 Window 实例列表。

返回
返回

Promise<Window[]>

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L345

getByLabel()
标题为“getByLabel()”的章节
static getByLabel(label): Promise<null | Window>

获取与给定标签关联的 Window。

参数
参数
参数类型描述
标签字符串窗口标签。
返回
返回

Promise<null | Window>

用于与窗口通信的 Window 实例，如果窗口不存在则为 null。

示例
示例
import { Window } from '@tauri-apps/api/window';
const mainWindow = Window.getByLabel('main');

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L331

getCurrent()
标题为“getCurrent()”的章节
static getCurrent(): Window

获取当前窗口的 Window 实例。

返回
返回

窗口

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L338

getFocusedWindow()
标题为“getFocusedWindow()”的章节
static getFocusedWindow(): Promise<null | Window>

获取焦点窗口。

返回
返回

Promise<null | Window>

Window 实例，如果没有任何焦点窗口，则为 undefined。

示例
示例
import { Window } from '@tauri-apps/api/window';
const focusedWindow = Window.getFocusedWindow();

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L359

接口

标题为“Interfaces”的章节

效果

标题为“Effects”的章节

窗口效果配置对象

始于

标题为“自”的章节

2.0.0

属性

属性
属性类型描述定义于
color?颜色窗口效果颜色。仅在 Windows 10 v1903+ 上影响 Effect.Blur 和 Effect.Acrylic。对 Windows 7 或 Windows 11 没有影响。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2266
effects效果[]要应用于窗口的窗口效果列表。冲突的效果将应用第一个并忽略其余的。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2253
radius?数字窗口效果圆角半径仅限 macOS来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2261
state?效果状态窗口效果状态仅限 macOS来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2257

显示器

标题为“Monitor”的章节

允许您检索有关给定显示器的信息。

始于

标题为“自”的章节

1.0.0

属性

属性
属性类型描述定义于
namenull | string显示器的人性化名称来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L49
position物理位置显示器相对于更大全屏区域的左上角位置。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L53
scaleFactor数字可用于将物理像素映射到逻辑像素的比例因子。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L60
size物理大小显示器分辨率。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L51
workArea对象显示器的工作区域。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L55
workArea.position物理位置-来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L56
workArea.size物理大小-来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L57

进度条状态

标题为“ProgressBarState”的章节

属性

属性
属性类型描述定义于
progress?数字进度条进度。值范围为 0 到 100来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L208
status?进度条状态进度条状态。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L204

比例因子已更改

标题为“ScaleFactorChanged”的章节

scaleChange 事件的负载。

始于

标题为“自”的章节

1.0.2

属性

属性
属性类型描述定义于
scaleFactor数字新窗口缩放因子。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L83
size物理大小新窗口尺寸来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L85

窗口选项

标题为“WindowOptions”的章节

要创建的窗口配置。

始于

标题为“自”的章节

1.0.0

属性

属性
属性类型描述定义于
allowLinkPreview?布尔值 (boolean)在 macOS 和 iOS 上，长按链接会显示链接预览，默认启用。请参阅 https://docs.rs/objc2-web-kit/latest/objc2_web_kit/struct.WKWebView.html#method.allowsLinkPreview来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2468
alwaysOnBottom?布尔值 (boolean)窗口是否应始终位于其他窗口下方。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2341
alwaysOnTop?布尔值 (boolean)窗口是否应始终位于其他窗口之上。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2339
backgroundColor?颜色设置窗口背景颜色。平台特定：- Android / iOS： 不支持。- Windows：alpha 通道被忽略。自 2.1.0 起来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2445
backgroundThrottling?后台节流策略更改默认的后台节流行为。## 平台特定 - Linux / Windows / Android：不支持。像挂起的 WebLock 事务这样的变通方法可能足够。- iOS：自 17.0+ 版本起支持。- macOS：自 14.0+ 版本起支持。请参阅 https://github.com/tauri-apps/tauri/issues/5250#issuecomment-2569380578 自 2.3.0 起来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2459
center?布尔值 (boolean)在屏幕中央显示窗口。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2284
closable?布尔值 (boolean)窗口的本地关闭按钮是否启用。默认为 true。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2400
contentProtected?布尔值 (boolean)防止窗口内容被其他应用程序捕获。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2343
decorations?布尔值 (boolean)窗口是否应该有边框和标题栏。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2337
disableInputAccessoryView?布尔值 (boolean)允许在 iOS 上禁用输入辅助视图。辅助视图是当文本输入元素获得焦点时出现在键盘上方的视图。它通常显示带有“完成”、“下一步”按钮的视图。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2475
focus?布尔值 (boolean)窗口是否应在创建时立即获得焦点。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2323
focusable?布尔值 (boolean)窗口是否可以获得焦点。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2325
fullscreen?布尔值 (boolean)窗口是否处于全屏模式。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2321
height?数字初始高度。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2292
hiddenTitle?布尔值 (boolean)如果为 true，则在 macOS 上隐藏窗口标题。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2381
javascriptDisabled?布尔值 (boolean)我们是否应该禁用 webview 上的 JavaScript 代码执行。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2463
maxHeight?数字最大高度。仅当 maxWidth 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2300
maxWidth?数字最大宽度。仅当 maxHeight 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2298
maximizable?布尔值 (boolean)窗口的本地最大化按钮是否启用。默认为 true。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2392
maximized?布尔值 (boolean)窗口是否应在创建时最大化。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2333
minHeight?数字最小高度。仅当 minWidth 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2296
minWidth?数字最小宽度。仅当 minHeight 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2294
minimizable?布尔值 (boolean)窗口的本地最小化按钮是否启用。默认为 true。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2396
parent?string | Window | WebviewWindow设置要创建的窗口的父级。可以是 Window 或窗口的标签。平台特定 - Windows：这将传入的父级设置为要创建的窗口的所有者窗口。来自 MSDN 拥有的窗口文档：- 拥有的窗口始终位于其所有者在 Z 顺序的上方。- 当所有者被销毁时，系统会自动销毁拥有的窗口。- 当所有者最小化时，拥有的窗口被隐藏。- Linux：这将使新窗口对父级瞬时，请参阅 https://docs.gtk.org.cn/gtk3/method.Window.set_transient_for.html - macOS：这将窗口添加为父级的子窗口，请参阅 https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2414
preventOverflow?boolean | PreventOverflowMargin在创建时防止窗口溢出工作区域（例如显示器大小 - 任务栏大小），这意味着窗口大小将限制为 显示器大小 - 任务栏大小。可以设置为 true 或 PreventOverflowMargin 对象，以设置在确定工作区域时应考虑的额外边距（在这种情况下，窗口大小将限制为 显示器大小 - 任务栏大小 - 边距）。注意：溢出检查仅在窗口创建时执行，调整大小仍然可能导致溢出。平台特定 - iOS / Android： 不支持。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2315
resizable?布尔值 (boolean)窗口是否可调整大小。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2317
shadow?布尔值 (boolean)窗口是否具有阴影。平台特定 - Windows： - false 对装饰窗口没有影响，阴影始终开启。 - true 会使无装饰窗口具有 1 像素的白色边框，并且在 Windows 11 上，它将具有圆角。 - Linux： 不支持。自 2.0.0 起来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2359
skipTaskbar?布尔值 (boolean)窗口图标是否应添加到任务栏。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2345
tabbingIdentifier?字符串在 macOS 上定义窗口的 tabbing identifier。具有相同 tabbing identifier 的窗口将分组在一起。如果未设置 tabbing identifier，则将禁用自动 tabbing。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2388
theme?主题初始窗口主题。默认为系统主题。仅在 Windows 和 macOS 10.14+ 上实现。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2365
title?字符串窗口标题。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2319
titleBarStyle?标题栏样式macOS 标题栏的样式。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2369
trafficLightPosition?逻辑位置macOS 上窗口控制按钮的位置。需要 titleBarStyle: 'overlay' 和 decorations: true。自 2.4.0 起来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2377
transparent?布尔值 (boolean)窗口是否透明。请注意，在 macOS 上，这需要 macos-private-api 功能标志，在 tauri.conf.json > app > macOSPrivateApi 下启用。警告：在 macOS 上使用私有 API 会阻止您的应用程序被 App Store 接受。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2331
visible?布尔值 (boolean)窗口是否应在创建时立即可见。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2335
visibleOnAllWorkspaces?布尔值 (boolean)窗口是否应在所有工作区或虚拟桌面上可见。平台特定 - Windows / iOS / Android： 不支持。自 2.0.0 起来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2423
width?数字初始宽度。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2290
windowEffects?效果窗口效果。需要窗口是透明的。平台特定：- Windows：如果使用装饰或阴影，您可能需要尝试此解决方法 https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891 - Linux：不支持来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2434
x?数字初始垂直位置。仅当 y 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2286
y?数字初始水平位置。仅当 x 也设置时才适用。来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2288

窗口大小限制

标题为“WindowSizeConstraints”的章节

属性

属性
属性类型定义于
maxHeight?数字来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L197
maxWidth?数字来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L196
minHeight?数字来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L195
minWidth?数字来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L194

类型别名 (Type Aliases)

标题为“Type Aliases”的章节

光标图标

标题为“CursorIcon”的章节
type CursorIcon:
  | "default"
  | "crosshair"
  | "hand"
  | "arrow"
  | "move"
  | "text"
  | "wait"
  | "help"
  | "progress"
  | "notAllowed"
  | "contextMenu"
  | "cell"
  | "verticalText"
  | "alias"
  | "copy"
  | "noDrop"
  | "grab"
  | "grabbing"
  | "allScroll"
  | "zoomIn"
  | "zoomOut"
  | "eResize"
  | "nResize"
  | "neResize"
  | "nwResize"
  | "sResize"
  | "seResize"
  | "swResize"
  | "wResize"
  | "ewResize"
  | "nsResize"
  | "neswResize"
  | "nwseResize"
  | "colResize"
  | "rowResize";

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L129

主题

标题为“Theme”的章节
type Theme: "light" | "dark";

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L63

标题栏样式

标题为“TitleBarStyle”的章节
type TitleBarStyle: "visible" | "transparent" | "overlay";

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L64

函数

标题为“Functions”的章节

可用显示器()

标题为“availableMonitors()”的章节
function availableMonitors(): Promise<Monitor[]>

返回系统上所有可用显示器的列表。

返回

返回

Promise<Monitor[]>

示例

示例
import { availableMonitors } from '@tauri-apps/api/window';
const monitors = await availableMonitors();

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2554

当前显示器()

标题为“currentMonitor()”的章节
function currentMonitor(): Promise<Monitor | null>

返回窗口当前所在的显示器。如果无法检测到当前显示器，则返回 null。

返回

返回

Promise<Monitor | null>

示例

示例
import { currentMonitor } from '@tauri-apps/api/window';
const monitor = await currentMonitor();

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2504

光标位置()

标题为“cursorPosition()”的章节
function cursorPosition(): Promise<PhysicalPosition>

获取光标相对于桌面左上角的位置。

请注意，桌面的左上角不一定与屏幕相同。如果用户使用多显示器桌面，Windows 和 macOS 上的桌面左上角是主显示器的左上角，而 X11 上是左侧显示器的左上角。

如果窗口的左上角位于可见屏幕区域之外，则坐标可能为负数。

返回

返回

Promise<PhysicalPosition>

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2570

所有窗口()

标题为“getAllWindows()”的章节
function getAllWindows(): Promise<Window[]>

获取所有可用窗口的 Window 实例列表。

返回

返回

Promise<Window[]>

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L228

当前窗口()

标题为“getCurrentWindow()”的章节
function getCurrentWindow(): Window

获取当前窗口的 Window 实例。

返回

返回

窗口

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L216

点位显示器()

标题为“monitorFromPoint()”的章节
function monitorFromPoint(x, y): Promise<Monitor | null>

返回包含给定点的显示器。如果找不到任何显示器，则返回 null。

参数

参数
参数类型
x数字
y数字

返回

返回

Promise<Monitor | null>

示例

示例
import { monitorFromPoint } from '@tauri-apps/api/window';
const monitor = await monitorFromPoint(100.0, 200.0);

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2537

主显示器()

标题为“primaryMonitor()”的章节
function primaryMonitor(): Promise<Monitor | null>

返回系统的主显示器。如果无法将任何显示器识别为主显示器，则返回 null。

返回

返回

Promise<Monitor | null>

示例

示例
import { primaryMonitor } from '@tauri-apps/api/window';
const monitor = await primaryMonitor();

始于

标题为“自”的章节

1.0.0

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2521

在 Open Collective 上支持 在 GitHub 上赞助

© 2025 Tauri 贡献者。CC-BY / MIT