webviewWindow

参考

Color

重新导出 Color

DragDropEvent

重新导出 DragDropEvent

类

WebviewWindow

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

Webview 通过一个 _标签_（一个唯一的标识符，可用于后续引用）来标识。它只能包含字母数字字符 a-zA-Z 以及以下特殊字符 -, /, : 和 _。

示例

import { Window } from "@tauri-apps/api/window"
import { Webview } from "@tauri-apps/api/webview"

const appWindow = new Window('uniqueLabel');

appWindow.once('tauri://created', async function () {
  // `new Webview` Should be called after the window is successfully created,
  // or webview may not be attached to the window since window is not created yet.

  // loading embedded asset:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'path/to/page.html',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });
  // alternatively, load a remote URL:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'https://github.com/tauri-apps/tauri',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });

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

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

始于

2.0.0

继承 (Extends)

Webview.Window

构造函数

new WebviewWindow()

new WebviewWindow(label, options): WebviewWindow

创建新的 Window 来托管 Webview。

参数

参数	类型	描述
`标签`	`字符串`	唯一的 webview 标签。必须是字母数字字符：`a-zA-Z-/:_`。
`选项`	`Omit`<`WebviewOptions`, `"x"` \| `"y"` \| `"width"` \| `"height"`> & `WindowOptions`	-

WebviewWindow

用于与窗口和 webview 通信的 WebviewWindow 实例。

示例

import { WebviewWindow } from '@tauri-apps/api/webviewWindow'
const webview = new WebviewWindow('my-label', {
  url: 'https://github.com/tauri-apps/tauri'
});
webview.once('tauri://created', function () {
 // webview successfully created
});
webview.once('tauri://error', function (e) {
 // an error happened creating the webview
});

继承自 (Inherited from)

Window.constructor

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

属性

属性	类型	描述	继承自 (Inherited from)	定义于
`label`	`字符串`	webview 标签。它是 webview 的唯一标识符，可用于后续引用。	`Window`.`label`	源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L51
`listeners`	`Record`<`string`, `EventCallback`<`any`>[]>	本地事件监听器。	`Window`.`listeners`	源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L54
`window`	`窗口`	托管此 webview 的窗口。	`Webview`.`window`	源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L156

方法

center()

center(): Promise<void>

将窗口居中。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.center

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

clearAllBrowsingData()

clearAllBrowsingData(): Promise<void>

清除此 webview 的所有浏览数据。

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().clearAllBrowsingData();

继承自 (Inherited from)

Webview.clearAllBrowsingData

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

clearEffects()

clearEffects(): Promise<void>

清除所有应用的效果（如果可能）。

Promise<void>

继承自 (Inherited from)

Window.clearEffects

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

close()

close(): Promise<void>

关闭 webview。

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().close();

继承自 (Inherited from)

Window.close

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

destroy()

destroy(): Promise<void>

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

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.destroy

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

emit()

emit<T>(event, payload?): Promise<void>

向所有目标发出事件。

类型参数

类型参数
`T`

参数

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

Promise<void>

示例

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

继承自 (Inherited from)

Window.emit

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

emitTo()

emitTo<T>(
   target,
   event,
payload?): Promise<void>

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

类型参数

类型参数
`T`

参数

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

Promise<void>

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().emitTo('main', 'webview-loaded', { loggedIn: true, token: 'authToken' });

继承自 (Inherited from)

Window.emitTo

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

hide()

hide(): Promise<void>

隐藏 webview。

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().hide();

继承自 (Inherited from)

Window.hide

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

innerPosition()

innerPosition(): Promise<PhysicalPosition>

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

Promise<PhysicalPosition>

窗口的内部位置。

示例

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

继承自 (Inherited from)

Window.innerPosition

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

innerSize()

innerSize(): Promise<PhysicalSize>

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

Promise<PhysicalSize>

窗口的内部大小。

示例

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

继承自 (Inherited from)

Window.innerSize

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

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>

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

Promise<boolean>

窗口是否可见。

示例

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

继承自 (Inherited from)

Window.isAlwaysOnTop

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

isClosable()

isClosable(): Promise<boolean>

获取窗口的原生关闭按钮状态。

平台特定

iOS / Android: 不支持。

Promise<boolean>

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

示例

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

继承自 (Inherited from)

Window.isClosable

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

isDecorated()

isDecorated(): Promise<boolean>

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

Promise<boolean>

窗口是否已装饰。

示例

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

继承自 (Inherited from)

Window.isDecorated

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

isEnabled()

isEnabled(): Promise<boolean>

窗口是否启用或禁用。

Promise<boolean>

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

示例

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

始于

2.0.0

继承自 (Inherited from)

Window.isEnabled

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

isFocused()

isFocused(): Promise<boolean>

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

Promise<boolean>

窗口是否聚焦。

示例

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

继承自 (Inherited from)

Window.isFocused

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

isFullscreen()

isFullscreen(): Promise<boolean>

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

Promise<boolean>

窗口是否处于全屏模式。

示例

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

继承自 (Inherited from)

Window.isFullscreen

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

isMaximizable()

isMaximizable(): Promise<boolean>

获取窗口原生最大化按钮的状态。

平台特定

Linux / iOS / Android： 不支持。

Promise<boolean>

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

示例

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

继承自 (Inherited from)

Window.isMaximizable

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

isMaximized()

isMaximized(): Promise<boolean>

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

Promise<boolean>

窗口是否最大化。

示例

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

继承自 (Inherited from)

Window.isMaximized

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

isMinimizable()

isMinimizable(): Promise<boolean>

获取窗口的原生最小化按钮状态。

平台特定

Linux / iOS / Android： 不支持。

Promise<boolean>

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

示例

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

继承自 (Inherited from)

Window.isMinimizable

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

isMinimized()

isMinimized(): Promise<boolean>

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

Promise<boolean>

示例

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

继承自 (Inherited from)

Window.isMinimized

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

isResizable()

isResizable(): Promise<boolean>

获取窗口当前的可调整大小状态。

Promise<boolean>

窗口是否可调整大小。

示例

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

继承自 (Inherited from)

Window.isResizable

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

isVisible()

isVisible(): Promise<boolean>

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

Promise<boolean>

窗口是否可见。

示例

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

继承自 (Inherited from)

Window.isVisible

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

listen()

listen<T>(event, handler): Promise<UnlistenFn>

侦听此 webivew 窗口上发出的事件。

类型参数

类型参数
`T`

参数

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

Promise<UnlistenFn>

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

示例

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().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();

继承自 (Inherited from)

Window.listen

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

maximize()

maximize(): Promise<void>

最大化窗口。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.maximize

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

minimize()

minimize(): Promise<void>

最小化窗口。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.minimize

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

onCloseRequested()

onCloseRequested(handler): Promise<UnlistenFn>

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

参数

参数	类型
`处理程序`	(`event`) => `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();

继承自 (Inherited from)

Window.onCloseRequested

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

onDragDropEvent()

onDragDropEvent(handler): Promise<UnlistenFn>

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

参数

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

Promise<UnlistenFn>

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

示例

import { getCurrentWebview } from "@tauri-apps/api/webview";
const unlisten = await getCurrentWebview().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();

当调试器面板打开时，由于已知限制，此事件的拖放位置可能不准确。要检索正确的拖放位置，请分离调试器。

继承自 (Inherited from)

Window.onDragDropEvent

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

onFocusChanged()

onFocusChanged(handler): Promise<UnlistenFn>

监听窗口焦点变化。

参数

参数	类型
`处理程序`	`EventCallback`<`boolean`>

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();

继承自 (Inherited from)

Window.onFocusChanged

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

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();

继承自 (Inherited from)

Window.onMoved

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

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();

继承自 (Inherited from)

Window.onResized

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

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();

继承自 (Inherited from)

Window.onScaleChanged

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

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();

继承自 (Inherited from)

Window.onThemeChanged

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

once()

once<T>(event, handler): Promise<UnlistenFn>

仅在此 webview 窗口上侦听一次发出的事件。

类型参数

类型参数
`T`

参数

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

Promise<UnlistenFn>

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

示例

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().once<null>('initialized', (event) => {
  console.log(`Webview initialized!`);
});

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

继承自 (Inherited from)

Window.once

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

outerPosition()

outerPosition(): Promise<PhysicalPosition>

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

Promise<PhysicalPosition>

窗口的外部位置。

示例

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

继承自 (Inherited from)

Window.outerPosition

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

outerSize()

outerSize(): Promise<PhysicalSize>

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

Promise<PhysicalSize>

窗口的外部大小。

示例

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

继承自 (Inherited from)

Window.outerSize

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

position()

position(): Promise<PhysicalPosition>

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

Promise<PhysicalPosition>

webview 的位置。

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
const position = await getCurrentWebview().position();

继承自 (Inherited from)

Webview.position

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

reparent()

reparent(window): Promise<void>

将此 webview 移动到给定的标签。

参数

参数	类型
`window`	`string` \| `Window` \| `WebviewWindow`

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().reparent('other-window');

继承自 (Inherited from)

Webview.reparent

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

requestUserAttention()

requestUserAttention(requestType): Promise<void>

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

提供 null 将取消对用户关注的请求。当窗口接收到输入时，WM 可能不会自动取消用户关注的请求。

平台特定

macOS： null 无效。
Linux： 紧急程度具有相同的效果。

参数

参数	类型
`requestType`	`null` \| `UserAttentionType`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.requestUserAttention

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

scaleFactor()

scaleFactor(): Promise<number>

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

Promise<number>

窗口的监视器缩放因子。

示例

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

继承自 (Inherited from)

Window.scaleFactor

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

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise<void>

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

参数

参数	类型	描述
`alwaysOnBottom`	`布尔值 (boolean)`	窗口是否应始终位于其他窗口下方。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setAlwaysOnBottom

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

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>

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

参数

参数	类型	描述
`alwaysOnTop`	`布尔值 (boolean)`	窗口是否应始终位于其他窗口之上。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setAlwaysOnTop

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

setAutoResize()

setAutoResize(autoResize): Promise<void>

设置当父窗口调整大小时，webview 是否应自动增长和收缩其大小和位置。

参数

参数	类型
`autoResize`	`布尔值 (boolean)`

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setAutoResize(true);

继承自 (Inherited from)

Webview.setAutoResize

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

setBackgroundColor()

setBackgroundColor(color): Promise<void>

设置窗口和 webview 背景颜色。

平台特定

Android / iOS： 窗口层不支持。
macOS / iOS： webview 层未实现。
Windows:
- 窗口层的 alpha 通道被忽略。
- 在 Windows 7 上，webview 层的 alpha 通道被忽略。
- 在 Windows 8 及更高版本上，如果 alpha 通道不为 0，则会被忽略。

参数

参数	类型
`颜色`	`Color`

Promise<void>

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

始于

2.1.0

继承自 (Inherited from)

Window.setBackgroundColor

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

setBadgeCount()

setBadgeCount(count?): Promise<void>

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

平台特定

Windows： 不支持。请改用 @{linkcode Window.setOverlayIcon}。

参数

参数	类型	描述
`count`?	`数字`	徽章计数。使用 `undefined` 删除徽章。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setBadgeCount

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

setBadgeLabel()

setBadgeLabel(label?): Promise<void>

设置徽章内容，仅支持 **macOS**。

参数

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

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setBadgeLabel

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

setClosable()

setClosable(closable): Promise<void>

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

平台特定

Linux： GTK+ 将尽力说服窗口管理器不显示关闭按钮。根据系统不同，此功能在已可见的窗口上调用时可能无效。
iOS / Android: 不支持。

参数

参数	类型
`可关闭`	`布尔值 (boolean)`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setClosable

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

setContentProtected()

setContentProtected(protected_): Promise<void>

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

参数

参数	类型
`protected_`	`布尔值 (boolean)`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setContentProtected

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

setCursorGrab()

setCursorGrab(grab): Promise<void>

抓取光标，防止光标离开窗口。

无法保证光标会隐藏。如果您希望隐藏，应自行隐藏。

平台特定

Linux： 不支持。
macOS： 这会将光标锁定在固定位置，视觉上会显得很笨拙。

参数

参数	类型	描述
`grab`	`布尔值 (boolean)`	`true` 抓取光标图标，`false` 释放光标图标。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setCursorGrab

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

setCursorIcon()

setCursorIcon(icon): Promise<void>

修改窗口的光标图标。

参数

参数	类型	描述
`icon`	`光标图标`	新的光标图标。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setCursorIcon

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

setCursorPosition()

setCursorPosition(position): Promise<void>

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

参数

参数	类型	描述
`位置`	`LogicalPosition` \| `PhysicalPosition` \| `Position`	新的光标位置。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setCursorPosition

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

setCursorVisible()

setCursorVisible(visible): Promise<void>

修改光标的可见性。

平台特定

Windows： 光标仅在窗口范围内隐藏。
macOS： 只要窗口有输入焦点，即使光标在窗口外，也会隐藏光标。

参数

参数	类型	描述
`可见`	`布尔值 (boolean)`	如果为 `false`，这将隐藏光标。如果为 `true`，这将显示光标。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setCursorVisible

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

setDecorations()

setDecorations(decorations): Promise<void>

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

参数

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

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setDecorations

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

setEffects()

setEffects(effects): Promise<void>

设置窗口效果。

参数

参数	类型
`效果`	`效果`

Promise<void>

继承自 (Inherited from)

Window.setEffects

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

setEnabled()

setEnabled(enabled): Promise<void>

启用或禁用窗口。

参数

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

Promise<void>

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

示例

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

始于

2.0.0

继承自 (Inherited from)

Window.setEnabled

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

setFocus()

setFocus(): Promise<void>

将 webview 置于最前端并聚焦。

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setFocus();

继承自 (Inherited from)

Window.setFocus

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

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);

继承自 (Inherited from)

Window.setFocusable

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

setFullscreen()

setFullscreen(fullscreen): Promise<void>

设置窗口全屏状态。

参数

参数	类型	描述
`全屏`	`布尔值 (boolean)`	窗口是否全屏。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setFullscreen

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

setIcon()

setIcon(icon): Promise<void>

设置窗口图标。

参数

参数	类型	描述
`icon`	\| `string` \| `Uint8Array` \| `number`[] \| `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"] }

继承自 (Inherited from)

Window.setIcon

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

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>

更改光标事件行为。

参数

参数	类型	描述
`忽略`	`布尔值 (boolean)`	`true` 忽略光标事件；`false` 正常处理。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setIgnoreCursorEvents

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

setMaxSize()

setMaxSize(size): Promise<void>

设置窗口的最大内部尺寸。如果 size 参数未定义，则取消限制。

参数

参数	类型	描述
`尺寸`	\| `undefined` \| `null` \| `LogicalSize` \| `PhysicalSize` \| `Size`	逻辑或物理内部尺寸，或 `null` 取消约束。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setMaxSize

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

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);

继承自 (Inherited from)

Window.setMaximizable

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

setMinSize()

setMinSize(size): Promise<void>

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

参数

参数	类型	描述
`尺寸`	\| `undefined` \| `null` \| `LogicalSize` \| `PhysicalSize` \| `Size`	逻辑或物理内部尺寸，或 `null` 取消约束。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setMinSize

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

setMinimizable()

setMinimizable(minimizable): Promise<void>

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

平台特定

Linux / iOS / Android： 不支持。

参数

参数	类型
`可最小化`	`布尔值 (boolean)`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setMinimizable

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

setOverlayIcon()

setOverlayIcon(icon?): Promise<void>

设置覆盖图标。**仅限 Windows**。每个窗口都可以设置覆盖图标。

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

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

参数

参数	类型	描述
`icon`?	\| `string` \| `Uint8Array` \| `number`[] \| `ArrayBuffer` \| `Image`	图标字节或图标文件路径。使用 `undefined` 删除覆盖图标。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setOverlayIcon

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

setPosition()

setPosition(position): Promise<void>

设置 webview 位置。

参数

参数	类型	描述
`位置`	`LogicalPosition` \| `PhysicalPosition` \| `Position`	新位置，以逻辑像素或物理像素表示。

Promise<void>

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

示例

import { getCurrent, LogicalPosition } from '@tauri-apps/api/webview';
await getCurrentWebview().setPosition(new LogicalPosition(600, 500));

继承自 (Inherited from)

Window.setPosition

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

setProgressBar()

setProgressBar(state): Promise<void>

设置任务栏进度状态。

平台特定

Linux / macOS： 进度条是应用程序范围的，不特定于此窗口。
Linux： 仅支持带有 libunity 的桌面环境（例如 GNOME）。

参数

参数	类型
`state`	`进度条状态`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setProgressBar

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

setResizable()

setResizable(resizable): Promise<void>

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

参数

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

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setResizable

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

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);

继承自 (Inherited from)

Window.setShadow

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

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): Promise<void>

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

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

参数

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

Promise<void>

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

继承自 (Inherited from)

Window.setSimpleFullscreen

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

setSize()

setSize(size): Promise<void>

调整 webview 大小。

参数

参数	类型	描述
`尺寸`	`LogicalSize` \| `PhysicalSize` \| `Size`	逻辑或物理大小。

Promise<void>

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

示例

import { getCurrent, LogicalSize } from '@tauri-apps/api/webview';
await getCurrentWebview().setSize(new LogicalSize(600, 500));

继承自 (Inherited from)

Window.setSize

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

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>

设置窗口内部大小约束。

参数

参数	类型	描述
`约束`	`undefined` \| `null` \| `WindowSizeConstraints`	逻辑或物理内部尺寸，或 `null` 取消约束。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setSizeConstraints

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

setSkipTaskbar()

setSkipTaskbar(skip): Promise<void>

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

平台特定

macOS： 不支持。

参数

参数	类型	描述
`跳过`	`布尔值 (boolean)`	true 隐藏窗口图标，false 显示窗口图标。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setSkipTaskbar

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

setTheme()

setTheme(theme?): Promise<void>

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

平台特定

Linux / macOS： 主题是应用程序范围的，不特定于此窗口。
iOS / Android: 不支持。

参数

参数	类型
`主题`?	`null` \| `Theme`

Promise<void>

始于

2.0.0

继承自 (Inherited from)

Window.setTheme

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

setTitle()

setTitle(title): Promise<void>

设置窗口标题。

参数

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

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.setTitle

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

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>

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

参数

参数	类型
`样式`	`标题栏样式`

Promise<void>

始于

2.0.0

继承自 (Inherited from)

Window.setTitleBarStyle

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

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible): Promise<void>

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

平台特定

Windows / iOS / Android： 不支持。

参数

参数	类型
`可见`	`布尔值 (boolean)`

Promise<void>

始于

2.0.0

继承自 (Inherited from)

Window.setVisibleOnAllWorkspaces

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

setZoom()

setZoom(scaleFactor): Promise<void>

设置 webview 缩放级别。

参数

参数	类型
`缩放因子`	`数字`

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setZoom(1.5);

继承自 (Inherited from)

Webview.setZoom

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

show()

show(): Promise<void>

显示 webview。

Promise<void>

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

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().show();

继承自 (Inherited from)

Window.show

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

size()

size(): Promise<PhysicalSize>

webview 客户端区域的物理尺寸。客户端区域是 webview 的内容，不包括标题栏和边框。

Promise<PhysicalSize>

webview 的大小。

示例

import { getCurrentWebview } from '@tauri-apps/api/webview';
const size = await getCurrentWebview().size();

继承自 (Inherited from)

Webview.size

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

startDragging()

startDragging(): Promise<void>

开始拖动窗口。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.startDragging

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

startResizeDragging()

startResizeDragging(direction): Promise<void>

开始拖动窗口以调整大小。

参数

参数	类型
`方向`	`调整大小方向`

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.startResizeDragging

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

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();

继承自 (Inherited from)

Window.theme

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

title()

title(): Promise<string>

获取窗口的当前标题。

Promise<string>

示例

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

继承自 (Inherited from)

Window.title

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

toggleMaximize()

toggleMaximize(): Promise<void>

切换窗口最大化状态。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.toggleMaximize

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

unmaximize()

unmaximize(): Promise<void>

取消窗口最大化。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.unmaximize

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

unminimize()

unminimize(): Promise<void>

取消窗口最小化。

Promise<void>

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

示例

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

继承自 (Inherited from)

Window.unminimize

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

getAll()

static getAll(): Promise<WebviewWindow[]>

获取所有可用 webview 的 Webview 实例列表。

Promise<WebviewWindow[]>

继承自 (Inherited from)

Window.getAll

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

getByLabel()

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

获取与给定标签关联的 webview 的 Webview 实例。

参数

参数	类型	描述
`标签`	`字符串`	webview 标签。

Promise<null | WebviewWindow>

与 webview 通信的 Webview 实例，如果 webview 不存在则为 null。

示例

import { Webview } from '@tauri-apps/api/webviewWindow';
const mainWebview = Webview.getByLabel('main');

继承自 (Inherited from)

Window.getByLabel

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

getCurrent()

static getCurrent(): WebviewWindow

获取当前 webview 的 Webview 实例。

WebviewWindow

继承自 (Inherited from)

Window.getCurrent

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

函数

getAllWebviewWindows()

function getAllWebviewWindows(): Promise<WebviewWindow[]>

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

Promise<WebviewWindow[]>

始于

2.0.0

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

getCurrentWebviewWindow()

function getCurrentWebviewWindow(): WebviewWindow

获取当前 webview 窗口的 Webview 实例。

WebviewWindow

始于

2.0.0

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

在 Open Collective 上支持在 GitHub 上赞助