@zturnlibs/ztron-api

---

window#

Enumerations#

Effect#

Defined in: window.ts:1047

macOS 活力材质（NSVisualEffectMaterial）。

Enumeration Members#

Acrylic#

Acrylic: "acrylic"

Defined in: window.ts:1065

AppearanceBased#

AppearanceBased: "appearanceBased"

Defined in: window.ts:1048

Blur#

Blur: "blur"

Defined in: window.ts:1064

仅 Windows（macOS 上为空操作，为跨平台配置保留）。

ContentBackground#

ContentBackground: "contentBackground"

Defined in: window.ts:1060

FullScreenUI#

FullScreenUI: "fullScreenUI"

Defined in: window.ts:1058

HeaderView#

HeaderView: "headerView"

Defined in: window.ts:1054

HudWindow#

HudWindow: "hudWindow"

Defined in: window.ts:1057

Menu#

Menu: "menu"

Defined in: window.ts:1051

Mica#

Mica: "mica"

Defined in: window.ts:1067

Popover#

Popover: "popover"

Defined in: window.ts:1052

Selection#

Selection: "selection"

Defined in: window.ts:1050

Sheet#

Sheet: "sheet"

Defined in: window.ts:1055

Sidebar#

Sidebar: "sidebar"

Defined in: window.ts:1053

Tabbed#

Tabbed: "tabbed"

Defined in: window.ts:1066

TabbedDark#

TabbedDark: "tabbedDark"

Defined in: window.ts:1068

TabbedLight#

TabbedLight: "tabbedLight"

Defined in: window.ts:1069

Titlebar#

Titlebar: "titlebar"

Defined in: window.ts:1049

ToolTip#

ToolTip: "toolTip"

Defined in: window.ts:1059

UnderPageBackground#

UnderPageBackground: "underPageBackground"

Defined in: window.ts:1062

UnderWindowBackground#

UnderWindowBackground: "underWindowBackground"

Defined in: window.ts:1061

WindowBackground#

WindowBackground: "windowBackground"

Defined in: window.ts:1056

---

EffectState#

Defined in: window.ts:1073

效果激活状态（仅 macOS）。

Enumeration Members#

Active#

Active: 0

Defined in: window.ts:1075

FollowsWindowActiveState#

FollowsWindowActiveState: -1

Defined in: window.ts:1074

Inactive#

Inactive: 1

Defined in: window.ts:1076

---

ProgressBarStatus#

Defined in: window.ts:74

dock/任务栏进度条状态（上游 ProgressBarStatus）。

Enumeration Members#

Error#

Error: "error"

Defined in: window.ts:79

Indeterminate#

Indeterminate: "indeterminate"

Defined in: window.ts:77

None#

None: "none"

Defined in: window.ts:75

Normal#

Normal: "normal"

Defined in: window.ts:76

Paused#

Paused: "paused"

Defined in: window.ts:78

---

UserAttentionType#

Defined in: window.ts:89

Window.requestUserAttention 的注意请求类型。

Enumeration Members#

Critical#

Critical: "Critical"

Defined in: window.ts:90

Informational#

Informational: "Informational"

Defined in: window.ts:91

Classes#

CloseRequestedEvent#

Defined in: window.ts:136

投递给 Window.onCloseRequested：在处理函数内调用 CloseRequestedEvent.preventDefault 可保持窗口打开（@tauri-apps/api CloseRequestedEvent 的移植）。

Constructors#

Constructor#

new CloseRequestedEvent(event): CloseRequestedEvent

Defined in: window.ts:142

Parameters#

event#

event#

string

id#

number

Returns#

CloseRequestedEvent

Properties#

event#

readonly event: string

Defined in: window.ts:137

id#

readonly id: number

Defined in: window.ts:138

Methods#

isPreventDefault()#

isPreventDefault(): boolean

Defined in: window.ts:151

Returns#

boolean

preventDefault()#

preventDefault(): void

Defined in: window.ts:147

Returns#

void

---

Window#

Defined in: window.ts:156

Extended by#

• WebviewWindow

Constructors#

Constructor#

new Window(label): Window

Defined in: window.ts:159

Parameters#

label#

string

Returns#

Window

Properties#

label#

readonly label: string

Defined in: window.ts:157

Methods#

activityName()#

activityName(): Promise<string | null>

Defined in: window.ts:365

上游仅 Android：当前 activity 名（桌面端为 null）。

Returns#

Promise<string | null>

center()#

center(): Promise<void>

Defined in: window.ts:685

Returns#

Promise<void>

clearEffects()#

clearEffects(): Promise<void>

Defined in: window.ts:300

移除已应用的活力效果。

Returns#

Promise<void>

close()#

close(): Promise<void>

Defined in: window.ts:537

Returns#

Promise<void>

cursorPosition()#

cursorPosition(): Promise<{ x: number; y: number; }>

Defined in: window.ts:388

屏幕坐标系中的光标位置（无需 label；上游对齐）。

Returns#

Promise<{ x: number; y: number; }>

destroy()#

destroy(): Promise<void>

Defined in: window.ts:421

强制关闭窗口，绕过 preventClose。

Returns#

Promise<void>

getState()#

getState(): Promise<{ alwaysOnTop: boolean; fullscreen: boolean; maximized: boolean; minimized: boolean; resizable: boolean; visible: boolean; } | null>

Defined in: window.ts:713

读取窗口的布尔状态位（maximized/fullscreen 等）。

Returns#

Promise<{ alwaysOnTop: boolean; fullscreen: boolean; maximized: boolean; minimized: boolean; resizable: boolean; visible: boolean; } | null>

getTheme()#

getTheme(): Promise<string | null>

Defined in: window.ts:210

窗口跟随的 OS 配色（"light" | "dark"）。

Returns#

Promise<string | null>

getTitle()#

getTitle(): Promise<string>

Defined in: window.ts:183

当前原生窗口标题。

Returns#

Promise<string>

hide()#

hide(): Promise<void>

Defined in: window.ts:229

Returns#

Promise<void>

innerPosition()#

innerPosition(): Promise<{ x: number; y: number; }>

Defined in: window.ts:765

窗口内容区位置（内容左上角）。以外框原点近似——精确内容原点需要测量标题栏高度。

Returns#

Promise<{ x: number; y: number; }>

innerSize()#

innerSize(): Promise<{ height: number; width: number; }>

Defined in: window.ts:200

窗口内容区尺寸（点）——不含标题栏。

Returns#

Promise<{ height: number; width: number; }>

isAlwaysOnTop()#

isAlwaysOnTop(): Promise<boolean>

Defined in: window.ts:725

窗口是否置顶于其他窗口。

Returns#

Promise<boolean>

isClosable()#

isClosable(): Promise<boolean>

Defined in: window.ts:642

原生关闭按钮是否启用。

Returns#

Promise<boolean>

isDecorated()#

isDecorated(): Promise<boolean>

Defined in: window.ts:647

窗口是否有原生装饰（标题栏/边框）。

Returns#

Promise<boolean>

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: window.ts:193

窗口是否启用（macOS：始终 true——无对应 NSWindow 状态）。

Returns#

Promise<boolean>

isFocused()#

isFocused(): Promise<boolean>

Defined in: window.ts:652

窗口当前是否持有焦点（key window）。

Returns#

Promise<boolean>

isFullscreen()#

isFullscreen(): Promise<boolean>

Defined in: window.ts:580

Returns#

Promise<boolean>

isMaximizable()#

isMaximizable(): Promise<boolean>

Defined in: window.ts:627

原生最大化/缩放按钮是否启用。

Returns#

Promise<boolean>

isMaximized()#

isMaximized(): Promise<boolean>

Defined in: window.ts:565

Returns#

Promise<boolean>

isMinimizable()#

isMinimizable(): Promise<boolean>

Defined in: window.ts:612

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

Returns#

Promise<boolean>

isMinimized()#

isMinimized(): Promise<boolean>

Defined in: window.ts:569

Returns#

Promise<boolean>

isResizable()#

isResizable(): Promise<boolean>

Defined in: window.ts:735

窗口是否可调整尺寸。

Returns#

Promise<boolean>

isVisible()#

isVisible(): Promise<boolean>

Defined in: window.ts:730

窗口是否可见。

Returns#

Promise<boolean>

maximize()#

maximize(): Promise<void>

Defined in: window.ts:556

直接设置原生最大化状态（非切换，Tauri v2 拆分）。

Returns#

Promise<void>

minimize()#

minimize(): Promise<void>

Defined in: window.ts:543

Returns#

Promise<void>

onBlurred()#

onBlurred(handler): Promise<UnlistenFn>

Defined in: window.ts:926

Parameters#

handler#

() => void

Returns#

Promise<UnlistenFn>

onCloseRequested()#

onCloseRequested(handler): Promise<() => void>

Defined in: window.ts:947

请求关闭时触发。处理函数动态决定：调用 event.preventDefault() 保持窗口打开，否则处理函数完成后窗口被销毁（Tauri v2 语义）。

Parameters#

handler#

(event) => unknown

Returns#

Promise<() => void>

onDragDropEvent()#

onDragDropEvent(handler): () => void

Defined in: window.ts:310

归一化的拖放通知（Tauri DragDropEvent）：enter 携带 paths + position，over 仅 position，drop 携带 paths + position，leave 在拖拽离开窗口未放下时触发。位置为相对窗口左上角的物理像素。

Parameters#

handler#

(payload) => void

Returns#

() => void

onFocusChanged()#

onFocusChanged(handler): Promise<() => void>

Defined in: window.ts:931

焦点 + 失焦合并（Tauri v2 语法糖）。

Parameters#

handler#

(focused) => void

Returns#

Promise<() => void>

onFocused()#

onFocused(handler): Promise<UnlistenFn>

Defined in: window.ts:922

Parameters#

handler#

() => void

Returns#

Promise<UnlistenFn>

onMoved()#

onMoved(handler): Promise<UnlistenFn>

Defined in: window.ts:891

Parameters#

handler#

(payload) => void

Returns#

Promise<UnlistenFn>

onResized()#

onResized(handler): Promise<UnlistenFn>

Defined in: window.ts:887

Parameters#

handler#

(payload) => void

Returns#

Promise<UnlistenFn>

onScaleChanged()#

onScaleChanged(handler): Promise<UnlistenFn>

Defined in: window.ts:966

缩放因子变化时触发（在 Retina 显示器间移动）。

Parameters#

handler#

(payload) => void

Returns#

Promise<UnlistenFn>

onThemeChanged()#

onThemeChanged(handler): Promise<UnlistenFn>

Defined in: window.ts:973

系统主题变化时触发（载荷："dark" | "light"）。

Parameters#

handler#

(theme) => void

Returns#

Promise<UnlistenFn>

outerPosition()#

outerPosition(): Promise<{ x: number; y: number; }>

Defined in: window.ts:751

窗口外框位置（左上角原点）。

Returns#

Promise<{ x: number; y: number; }>

outerSize()#

outerSize(): Promise<{ height: number; width: number; }>

Defined in: window.ts:740

窗口外框尺寸（宽 × 高，含装饰）。

Returns#

Promise<{ height: number; width: number; }>

preventClose()#

preventClose(prevent): Promise<void>

Defined in: window.ts:416

阻止窗口关闭；改为发出 ztron://close-requested 事件，由前端确认（随后调用 destroy()）。

Parameters#

prevent#

boolean

Returns#

Promise<void>

requestUserAttention()#

requestUserAttention(type?): Promise<void>

Defined in: window.ts:676

弹跳 dock 图标直至激活。null 取消请求。（macOS 将 Critical/Informational 映射为弹跳样式。）

Parameters#

type?#

UserAttentionType | null

Returns#

Promise<void>

scaleFactor()#

scaleFactor(): Promise<number | null>

Defined in: window.ts:234

窗口的缩放因子（Retina/HiDPI 上为 2）。

Returns#

Promise<number | null>

sceneIdentifier()#

sceneIdentifier(): Promise<string | null>

Defined in: window.ts:375

上游仅 iOS：当前 scene 标识符（桌面端为 null）。

Returns#

Promise<string | null>

setActivityName()#

setActivityName(name): Promise<void>

Defined in: window.ts:370

上游仅 Android：桌面端接受为已记录的空操作。

Parameters#

name#

string

Returns#

Promise<void>

setAlwaysOnBottom()#

setAlwaysOnBottom(alwaysOnBottom): Promise<void>

Defined in: window.ts:594

把窗口置于所有其他窗口之下（v2 新增）。

Parameters#

alwaysOnBottom#

boolean

Returns#

Promise<void>

setAlwaysOnTop()#

setAlwaysOnTop(alwaysOnTop): Promise<void>

Defined in: window.ts:586

Parameters#

alwaysOnTop#

boolean

Returns#

Promise<void>

setBackgroundColor()#

setBackgroundColor(color): Promise<void>

Defined in: window.ts:857

设置窗口背景色："#rrggbb"、"#rrggbbaa" 或 "transparent"。对无边框/透明窗口生效。

Parameters#

color#

string

Returns#

Promise<void>

setBadgeCount()#

setBadgeCount(count): Promise<void>

Defined in: window.ts:835

设置 dock 角标计数。null/undefined 移除角标。macOS dock / Windows 任务栏；其他平台不支持。

Parameters#

count#

number | null

Returns#

Promise<void>

setBadgeLabel()#

setBadgeLabel(badgeLabel): Promise<void>

Defined in: window.ts:846

设置 dock 角标为任意文本（仅 macOS）。null/undefined/"" 移除角标。

Parameters#

badgeLabel#

string | null

Returns#

Promise<void>

setBounds()#

setBounds(x, y, width?, height?): Promise<void>

Defined in: window.ts:437

一次调用设置窗口位置与尺寸（接受 dpi 类型）。

Parameters#

x#

PositionLike

y#

SizeLike

width?#

number

height?#

number

Returns#

Promise<void>

setClosable()#

setClosable(closable): Promise<void>

Defined in: window.ts:634

切换原生关闭按钮。

Parameters#

closable#

boolean

Returns#

Promise<void>

setContentProtected()#

setContentProtected(protect): Promise<void>

Defined in: window.ts:665

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

Parameters#

protect#

boolean

Returns#

Promise<void>

setCursor()#

setCursor(cursor): Promise<void>

Defined in: window.ts:345

设置窗口光标（CSS 风格名："default"、"pointer"、"text"、"crosshair"、"move"、"not-allowed"、各类 resize 光标等）。

Parameters#

cursor#

string

Returns#

Promise<void>

setCursorGrab()#

setCursorGrab(grab): Promise<void>

Defined in: window.ts:262

把光标锁定在当前位置（Tauri setCursorGrab）。macOS 上光标视觉上停在原地；传 false 释放。

Parameters#

grab#

boolean

Returns#

Promise<void>

setCursorIcon()#

setCursorIcon(icon): Promise<void>

Defined in: window.ts:350

setCursor 的别名（Tauri v2 名称）。

Parameters#

icon#

string

Returns#

Promise<void>

setCursorPosition()#

setCursorPosition(x, y?): Promise<void>

Defined in: window.ts:395

把光标移动到窗口坐标（接受 dpi 类型）。

Parameters#

x#

PositionLike

y?#

number

Returns#

Promise<void>

setCursorVisible()#

setCursorVisible(visible): Promise<void>

Defined in: window.ts:357

隐藏/显示系统光标（应用级隐藏计数——调用需配对）。

Parameters#

visible#

boolean

Returns#

Promise<void>

setDecorations()#

setDecorations(decorations): Promise<void>

Defined in: window.ts:783

切换原生窗口装饰（标题栏/边框）。

Parameters#

decorations#

boolean

Returns#

Promise<void>

setEffects()#

setEffects(effects): Promise<void>

Defined in: window.ts:292

设置活力材质（macOS）。Windows 独有效果在该平台被忽略。

Parameters#

effects#

Effects

Returns#

Promise<void>

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: window.ts:463

启用/禁用原生窗口。

Parameters#

enabled#

boolean

Returns#

Promise<void>

setFileDropEnabled()#

setFileDropEnabled(enabled): Promise<void>

Defined in: window.ts:251

启用/禁用原生文件拖放处理器。启用时（默认）文件拖放产生 onDragDropEvent 事件；禁用后页面可改用 HTML5 拖放 API。

Parameters#

enabled#

boolean

Returns#

Promise<void>

setFocus()#

setFocus(): Promise<void>

Defined in: window.ts:689

Returns#

Promise<void>

setFocusable()#

setFocusable(focusable): Promise<void>

Defined in: window.ts:896

切换窗口能否取得键盘焦点。

Parameters#

focusable#

boolean

Returns#

Promise<void>

setFullscreen()#

setFullscreen(fullscreen): Promise<void>

Defined in: window.ts:573

Parameters#

fullscreen#

boolean

Returns#

Promise<void>

setIcon()#

setIcon(icon): Promise<void>

Defined in: window.ts:273

以注册的 host 图像（Image）设置窗口/dock 图标。传 null 清除。

Parameters#

icon#

Image | null

Returns#

Promise<void>

setIgnoreCursorEvents()#

setIgnoreCursorEvents(ignore): Promise<void>

Defined in: window.ts:239

切换窗口是否忽略鼠标/光标事件。

Parameters#

ignore#

boolean

Returns#

Promise<void>

setMaximizable()#

setMaximizable(maximizable): Promise<void>

Defined in: window.ts:619

切换原生最大化/缩放按钮。

Parameters#

maximizable#

boolean

Returns#

Promise<void>

setMaxSize()#

setMaxSize(size): Promise<void>

Defined in: window.ts:510

设置窗口最大内容尺寸。null 取消约束（接受 dpi 类型）。

Parameters#

size#

SizeLike | null | undefined

Returns#

Promise<void>

setMinimizable()#

setMinimizable(minimizable): Promise<void>

Defined in: window.ts:604

切换原生最小化按钮（macOS/Windows；基于按钮掩码）。

Parameters#

minimizable#

boolean

Returns#

Promise<void>

setMinSize()#

setMinSize(size): Promise<void>

Defined in: window.ts:497

设置窗口最小内容尺寸。null 取消约束（接受 dpi 类型，如 new LogicalSize(300, 200)）。

Parameters#

size#

SizeLike | null | undefined

Returns#

Promise<void>

setOpacity()#

setOpacity(opacity): Promise<void>

Defined in: window.ts:705

设置窗口不透明度，0.0（全透明）到 1.0（不透明）。

Parameters#

opacity#

number

Returns#

Promise<void>

setOverlayIcon()#

setOverlayIcon(icon): Promise<void>

Defined in: window.ts:284

设置标题栏配件小图标（macOS 版的 Windows overlay/状态徽标）。传 null 清除。

Parameters#

icon#

Image | null

Returns#

Promise<void>

setPosition()#

setPosition(x, y?): Promise<void>

Defined in: window.ts:484

移动窗口。接受纯数字、LogicalPosition/PhysicalPosition 或普通 { x, y } 对象。

Parameters#

x#

PositionLike

y?#

number

Returns#

Promise<void>

setProgressBar()#

setProgressBar(progress): Promise<void>

Defined in: window.ts:809

设置 dock/任务栏进度（0.0–1.0），null 清除；macOS 上作用于应用级 dock tile，Windows 任务栏按窗口。接受裸确定值/null（v1 形状）或上游 ProgressBarState 对象：Indeterminate 切换旋转条，None 清除。

Parameters#

progress#

number | ProgressBarStateInput | null

Returns#

Promise<void>

setResizable()#

setResizable(resizable): Promise<void>

Defined in: window.ts:697

Parameters#

resizable#

boolean

Returns#

Promise<void>

setSceneIdentifier()#

setSceneIdentifier(id): Promise<void>

Defined in: window.ts:380

上游仅 iOS：桌面端接受为已记录的空操作。

Parameters#

id#

string

Returns#

Promise<void>

setShadow()#

setShadow(shadow): Promise<void>

Defined in: window.ts:458

切换原生窗口阴影。

Parameters#

shadow#

boolean

Returns#

Promise<void>

setSimpleFullscreen()#

setSimpleFullscreen(fullscreen): Promise<void>

Defined in: window.ts:915

无边框「简单」全屏：内容铺满屏幕而不经过原生全屏空间切换（退出时恢复边框与装饰）。

Parameters#

fullscreen#

boolean

Returns#

Promise<void>

setSize()#

setSize(width, height?): Promise<void>

Defined in: window.ts:471

设置窗口尺寸。接受纯数字、LogicalSize/PhysicalSize 或普通 { width, height } 对象。

Parameters#

width#

SizeLike

height?#

number

Returns#

Promise<void>

setSizeConstraints()#

setSizeConstraints(constraints): Promise<void>

Defined in: window.ts:520

一次调用设置最小/最大内容尺寸约束。

Parameters#

constraints#

WindowSizeConstraints | null | undefined

Returns#

Promise<void>

setSkipTaskbar()#

setSkipTaskbar(skipTaskbar): Promise<void>

Defined in: window.ts:657

从任务栏/dock 隐藏窗口图标（macOS：整个应用）。

Parameters#

skipTaskbar#

boolean

Returns#

Promise<void>

setTheme()#

setTheme(theme): Promise<void>

Defined in: window.ts:220

应用级主题覆盖（"dark"/"light"；null 跟随系统）。

Parameters#

theme#

"dark" | "light" | null

Returns#

Promise<void>

setTitle()#

setTitle(title): Promise<void>

Defined in: window.ts:178

Parameters#

title#

string

Returns#

Promise<void>

setTitleBarStyle()#

setTitleBarStyle(style): Promise<void>

Defined in: window.ts:869

设置标题栏样式（仅 macOS）："visible"（默认）、"transparent"（隐藏边框装饰）或 "overlay"（内容延伸至红绿灯之下——即 Tauri 的 transparent + 全尺寸内容视图）。

Parameters#

style#

TitleBarStyle

Returns#

Promise<void>

setTrafficLightPosition()#

setTrafficLightPosition(x, y): Promise<void>

Defined in: window.ts:981

移动红绿灯按钮（关闭/最小化/缩放）——用于 titleBarStyle: "overlay" 的无边框 macOS 窗口。

Parameters#

x#

number

y#

number

Returns#

Promise<void>

setTransparent()#

setTransparent(transparent): Promise<void>

Defined in: window.ts:775

切换透明窗口背景。

Parameters#

transparent#

boolean

Returns#

Promise<void>

setVisible()#

setVisible(visible): Promise<void>

Defined in: window.ts:693

Parameters#

visible#

boolean

Returns#

Promise<void>

setVisibleOnAllWorkspaces()#

setVisibleOnAllWorkspaces(visible): Promise<void>

Defined in: window.ts:904

在所有工作区/虚拟桌面显示窗口（macOS）。

Parameters#

visible#

boolean

Returns#

Promise<void>

setZoom()#

setZoom(zoom): Promise<void>

Defined in: window.ts:408

缩放 Web 内容（CSS zoom 系数，如 1.5）。

Parameters#

zoom#

number

Returns#

Promise<void>

show()#

show(): Promise<void>

Defined in: window.ts:225

setVisible(true) / setVisible(false) 的别名（Tauri v2 对齐）。

Returns#

Promise<void>

startDragging()#

startDragging(): Promise<void>

Defined in: window.ts:794

开始原生窗口拖拽——在无边框窗口的 data-tauri-drag-region 元素上响应 mousedown 调用。

Returns#

Promise<void>

startResizeDragging()#

startResizeDragging(direction?): Promise<void>

Defined in: window.ts:429

开始原生调整尺寸拖拽（direction："north"/"south"/"east"/"west" 或组合如 "southeast"）。macOS 未实现。

Parameters#

direction?#

string = "southeast"

Returns#

Promise<void>

theme()#

theme(): Promise<string | null>

Defined in: window.ts:215

OS 配色，getTheme 的别名（Tauri v2 对齐）。

Returns#

Promise<string | null>

title()#

title(): Promise<string>

Defined in: window.ts:188

设置窗口标题（setTitle 的别名，Tauri v2 对齐）。

Returns#

Promise<string>

toggleMaximize()#

toggleMaximize(): Promise<void>

Defined in: window.ts:551

Returns#

Promise<void>

unmaximize()#

unmaximize(): Promise<void>

Defined in: window.ts:561

还原最大化的窗口（未最大化时为空操作）。

Returns#

Promise<void>

unminimize()#

unminimize(): Promise<void>

Defined in: window.ts:547

Returns#

Promise<void>

getByLabel()#

static getByLabel(label): Promise<Window | null>

Defined in: window.ts:164

按 label 查找存活窗口（不存在时为 null）。

Parameters#

label#

string

Returns#

Promise<Window | null>

getCurrent()#

static getCurrent(): Window

Defined in: window.ts:169

当前窗口（label 来自引导元数据）。

Returns#

Window

Interfaces#

Effects#

Defined in: window.ts:1080

窗口效果配置（Tauri Effects）。

Properties#

color?#

optional color?: string | null

Defined in: window.ts:1084

effects#

effects: Effect[]

Defined in: window.ts:1081

radius?#

optional radius?: number

Defined in: window.ts:1083

state?#

optional state?: EffectState

Defined in: window.ts:1082

---

Monitor#

Defined in: window.ts:122

一台物理显示器（值为物理像素）。

Properties#

name#

name: string | null

Defined in: window.ts:123

position#

position: object

Defined in: window.ts:124

x#

x: number

y#

y: number

scaleFactor#

scaleFactor: number

Defined in: window.ts:128

size#

size: object

Defined in: window.ts:125

height#

height: number

width#

width: number

workArea#

workArea: object

Defined in: window.ts:127

可用区域（不含菜单栏/dock/任务栏）。

height#

height: number

width#

width: number

x#

x: number

y#

y: number

---

ProgressBarStateInput#

Defined in: window.ts:82

Properties#

status#

status: ProgressBarStatus

Defined in: window.ts:83

value?#

optional value?: number

Defined in: window.ts:85

status 为 Normal/Paused/Error 时的确定值。

---

WindowSizeConstraints#

Defined in: window.ts:98

窗口内容尺寸约束（逻辑像素；undefined = 未设置）。

Properties#

maxHeight?#

optional maxHeight?: number

Defined in: window.ts:102

maxWidth?#

optional maxWidth?: number

Defined in: window.ts:101

minHeight?#

optional minHeight?: number

Defined in: window.ts:100

minWidth?#

optional minWidth?: number

Defined in: window.ts:99

Type Aliases#

CursorIcon#

CursorIcon = typeof CursorIcon[keyof typeof CursorIcon]

Defined in: window.ts:34

setCursor/setCursorIcon 接受的 stock 光标形状（上游 CursorIcon 联合成员）。

---

TitleBarStyle#

TitleBarStyle = "visible" | "transparent" | "overlay"

Defined in: window.ts:95

标题栏样式（仅 macOS）。

---

WindowEventName#

WindowEventName = "resize" | "move" | "focus" | "blur" | "close-requested" | "suspended" | "resumed" | "scale-change" | "theme-changed" | "drag-enter" | "drag-over" | "drag-drop" | "drag-leave"

Defined in: window.ts:15

Variables#

CursorIcon#

const CursorIcon: object

Defined in: window.ts:34

setCursor/setCursorIcon 接受的 stock 光标形状（上游 CursorIcon 联合成员）。

Type Declaration#

Alias#

readonly Alias: "alias" = "alias"

AllScroll#

readonly AllScroll: "allScroll" = "allScroll"

Arrow#

readonly Arrow: "arrow" = "arrow"

Cell#

readonly Cell: "cell" = "cell"

ColResize#

readonly ColResize: "colResize" = "colResize"

ContextMenu#

readonly ContextMenu: "contextMenu" = "contextMenu"

Copy#

readonly Copy: "copy" = "copy"

Crosshair#

readonly Crosshair: "crosshair" = "crosshair"

Default#

readonly Default: "default" = "default"

EResize#

readonly EResize: "eResize" = "eResize"

EwResize#

readonly EwResize: "ewResize" = "ewResize"

Grab#

readonly Grab: "grab" = "grab"

Grabbing#

readonly Grabbing: "grabbing" = "grabbing"

Hand#

readonly Hand: "hand" = "hand"

Help#

readonly Help: "help" = "help"

Move#

readonly Move: "move" = "move"

NeResize#

readonly NeResize: "neResize" = "neResize"

NeswResize#

readonly NeswResize: "neswResize" = "neswResize"

NoDrop#

readonly NoDrop: "noDrop" = "noDrop"

NotAllowed#

readonly NotAllowed: "notAllowed" = "notAllowed"

NResize#

readonly NResize: "nResize" = "nResize"

NsResize#

readonly NsResize: "nsResize" = "nsResize"

NwResize#

readonly NwResize: "nwResize" = "nwResize"

NwseResize#

readonly NwseResize: "nwseResize" = "nwseResize"

Progress#

readonly Progress: "progress" = "progress"

RowResize#

readonly RowResize: "rowResize" = "rowResize"

SeResize#

readonly SeResize: "seResize" = "seResize"

SResize#

readonly SResize: "sResize" = "sResize"

SwResize#

readonly SwResize: "swResize" = "swResize"

Text#

readonly Text: "text" = "text"

VerticalText#

readonly VerticalText: "verticalText" = "verticalText"

Wait#

readonly Wait: "wait" = "wait"

WResize#

readonly WResize: "wResize" = "wResize"

ZoomIn#

readonly ZoomIn: "zoomIn" = "zoomIn"

ZoomOut#

readonly ZoomOut: "zoomOut" = "zoomOut"

Functions#

availableMonitors()#

availableMonitors(): Promise<Monitor[]>

Defined in: window.ts:997

全部显示器列表（物理像素）。

Returns#

Promise<Monitor[]>

---

currentMonitor()#

currentMonitor(): Promise<Monitor | null>

Defined in: window.ts:1005

包含当前窗口的显示器（离屏时为 null）。

Returns#

Promise<Monitor | null>

---

cursorPosition()#

cursorPosition(): Promise<{ x: number; y: number; }>

Defined in: window.ts:1091

屏幕坐标系中的全局鼠标位置——无需窗口 label（上游 cursorPosition() 独立辅助函数）。

Returns#

Promise<{ x: number; y: number; }>

---

getAllWindows()#

getAllWindows(): Promise<Window[]>

Defined in: window.ts:991

全部存活窗口的 label，包装为 Window 句柄。

Returns#

Promise<Window[]>

---

monitorFromPoint()#

monitorFromPoint(x, y): Promise<Monitor | null>

Defined in: window.ts:1015

包含该桌面点（物理像素，左上角原点）的显示器。

Parameters#

x#

number

y#

number

Returns#

Promise<Monitor | null>

---

primaryMonitor()#

primaryMonitor(): Promise<Monitor | null>

Defined in: window.ts:1010

主显示器。

Returns#

Promise<Monitor | null>

---

setupDragRegion()#

setupDragRegion(target?): () => void

Defined in: window.ts:1029

让所有带 data-tauri-drag-region 属性的元素可拖动窗口（Tauri 无边框窗口约定）。每页调用一次。

Parameters#

target?#

Document | HTMLElement

Returns#

() => void