Tauri (@tauri-apps/api)

https://tauri.app/zh-cn/reference/javascript/api
Admin
The JavaScript API for Tauri, a cross-platform app building toolkit. It enables frontend code to...
Tokens:40,471
Snippets:533
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### getAllWindows()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets a list of instances of Window for all available windows.

```APIDOC
## getAllWindows()

### Description
Gets a list of instances of Window for all available windows.

### Returns
- Promise<Window[]> - A promise that resolves to an array of Window instances.
```

--------------------------------

### getAll()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets a list of instances of Window for all available windows.

```APIDOC
## getAll()

### Description
Gets a list of instances of Window for all available windows.

### Returns
- **Promise<Window[]>** - A list of window instances.
```

--------------------------------

### startDragging()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Starts dragging the window.

```APIDOC
## startDragging()

### Description
Starts dragging the window.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### Get all windows

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves a list of all available window instances.

```typescript
static getAll(): Promise<Window[]>
```

--------------------------------

### getVersion()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the application version.

```APIDOC
## getVersion()

### Description
Gets the application version.

### Returns
- **Promise<string>** - The application version string.

### Example
```javascript
import { getVersion } from '@tauri-apps/api/app';
const appVersion = await getVersion();
```
```

--------------------------------

### startResizeDragging(direction)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Starts resize-dragging the window.

```APIDOC
## startResizeDragging(direction)

### Description
Starts resize-dragging the window.

### Parameters
- **direction** (ResizeDirection) - Required - The direction to resize.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### theme()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window's current theme.

```APIDOC
## theme()

### Description
Gets the window’s current theme.

### Returns
- **Promise<null | Theme>** - The window theme.

### Example
```javascript
import { getCurrentWindow } from '@tauri-apps/api/window';
const theme = await getCurrentWindow().theme();
```
```

--------------------------------

### getName()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the application name.

```APIDOC
## getName()

### Description
Gets the application name.

### Returns
- **Promise<string>** - The application name.

### Example
```javascript
import { getName } from '@tauri-apps/api/app';
const appName = await getName();
```
```

--------------------------------

### Mock Convert File Src Usage Example

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Shows how to mock the file source conversion for a specific operating system.

```typescript

import { mockConvertFileSrc } from "@tauri-apps/api/mocks";
import { convertFileSrc } from "@tauri-apps/api/core";


mockConvertFileSrc("windows")


const url = convertFileSrc("C:\\Users\\user\\file.txt")

```

--------------------------------

### Start Window Dragging

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Initiates a window drag operation.

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

--------------------------------

### getCurrentWindow()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Get an instance of Window for the current window.

```APIDOC
## getCurrentWindow()

### Description
Get an instance of Window for the current window.

### Returns
- Window - The instance of the current window.
```

--------------------------------

### isFullscreen()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets the window’s current fullscreen state.

```APIDOC
## isFullscreen()

### Description
Gets the window’s current fullscreen state.

### Returns
- **Promise<boolean>** - Whether the window is in fullscreen mode or not.

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

--------------------------------

### Get all webviews

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieves a list of all available Webview instances.

```typescript
function getAllWebviews(): Promise<Webview[]>
```

--------------------------------

### Get current window

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Returns the instance of the current window.

```typescript
function getCurrentWindow(): Window
```

--------------------------------

### Get application name

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the name of the application.

```typescript
import { getName } from '@tauri-apps/api/app';
const appName = await getName();
```

--------------------------------

### title()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window's current title.

```APIDOC
## title()

### Description
Gets the window’s current title.

### Returns
- **Promise<string>** - The window title.

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

--------------------------------

### get(id)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves a menu item by its identifier.

```APIDOC
## get(id)

### Description
Retrieves the menu item matching the given identifier.

### Parameters
- **id** (string) - Required - The identifier of the menu item.
```

--------------------------------

### Get Window Theme

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the current window theme, such as light or dark.

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

--------------------------------

### Get available monitors

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves a list of all monitors available on the system.

```typescript
function availableMonitors(): Promise<Monitor[]>
```

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

--------------------------------

### isDecorated()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets the window’s current decorated state.

```APIDOC
## isDecorated()

### Description
Gets the window’s current decorated state.

### Returns
- **Promise<boolean>** - Whether the window is decorated or not.

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

--------------------------------

### Get application version

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the version string of the application.

```typescript
import { getVersion } from '@tauri-apps/api/app';
const appVersion = await getVersion();
```

--------------------------------

### Start Window Resize Dragging

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Initiates a window resize operation in a specific direction.

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

--------------------------------

### Get picture directory

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Retrieves the platform-specific path to the user's picture directory.

```typescript

function pictureDir(): Promise<string>

```

```typescript

import { pictureDir } from '@tauri-apps/api/path';
const pictureDirPath = await pictureDir();

```

--------------------------------

### new(opts?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Creates a new menu instance.

```APIDOC
## new(opts?)

### Description
Create a new menu.

### Parameters
- **opts** (MenuOptions) - Optional - Configuration options for the menu.

### Returns
- **Promise** (Promise<Menu>) - The new menu instance.
```

--------------------------------

### isResizable()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s current resizable state.

```APIDOC
## isResizable()

### Description
Gets the window’s current resizable state.

### Returns
- **Promise<boolean>** - Whether the window is resizable or not.

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

--------------------------------

### show()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Makes the webview visible.

```APIDOC
## show()

### Description
Show the webview.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.
```

--------------------------------

### isVisible()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s current visible state.

```APIDOC
## isVisible()

### Description
Gets the window’s current visible state.

### Returns
- **Promise<boolean>** - Whether the window is visible or not.

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

--------------------------------

### Get primary monitor

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves the system's primary monitor.

```typescript
function primaryMonitor(): Promise<Monitor | null>
```

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

--------------------------------

### show()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Makes the webview visible.

```typescript

show(): Promise<void>

```

```typescript

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

```

--------------------------------

### getIdentifier()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the application identifier.

```APIDOC
## getIdentifier()

### Description
Gets the application identifier as configured in tauri.conf.json.

### Returns
- **Promise<string>** - The application identifier.

### Example
```javascript
import { getIdentifier } from '@tauri-apps/api/app';
const identifier = await getIdentifier();
```
```

--------------------------------

### Get public directory

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Retrieves the platform-specific path to the user's public directory.

```typescript

function publicDir(): Promise<string>

```

```typescript

import { publicDir } from '@tauri-apps/api/path';
const publicDirPath = await publicDir();

```

--------------------------------

### checkPermissions()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacecore

Get permission state for a plugin.

```APIDOC
## checkPermissions<T>(plugin)

### Description
Get permission state for a plugin. This should be used by plugin authors to wrap their actual implementation.

### Parameters
- **plugin** (string) - Required - The plugin name.

### Returns
- **Promise<T>** - The permission state.
```

--------------------------------

### Get WebviewWindow by label

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves a specific webview instance using its unique label identifier.

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

--------------------------------

### new(options?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacetray

Creates a new TrayIcon instance.

```APIDOC
## new(options?)

### Description
Creates a new TrayIcon.

### Parameters
- **options** (TrayIconOptions) - Optional - Configuration options for the tray icon.

### Returns
- **Promise<TrayIcon>**
```

--------------------------------

### getBundleType()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the application bundle type.

```APIDOC
## getBundleType()

### Description
Gets the application bundle type.

### Returns
- **Promise<BundleType>** - The bundle type of the application.

### Example
```javascript
import { getBundleType } from '@tauri-apps/api/app';
const type = await getBundleType();
```
```

--------------------------------

### Get resource directory

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Retrieves the path to the application's resource directory.

```typescript

function resourceDir(): Promise<string>

```

--------------------------------

### defaultWindowIcon()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the default window icon.

```APIDOC
## defaultWindowIcon()

### Description
Gets the default window icon.

### Returns
- **Promise<Image | null>** - The default window icon or null if not set.

### Example
```javascript
import { defaultWindowIcon } from '@tauri-apps/api/app';
const icon = await defaultWindowIcon();
```
```

--------------------------------

### PredefinedMenuItem.new()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Creates a new predefined menu item.

```APIDOC
## static new(opts?)

### Description
Create a new predefined menu item.

### Parameters
- **opts** (PredefinedMenuItemOptions) - Optional - Options for the menu item.

### Returns
- **Promise<PredefinedMenuItem>** - A promise that resolves to the new menu item.
```

--------------------------------

### show()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Sets the window visibility to true.

```APIDOC
## show()

### Description
Sets the window visibility to true.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.
```

--------------------------------

### outerSize()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Get the physical size of the entire window including title bar and borders.

```APIDOC
## outerSize()

### Description
The physical size of the entire window. These dimensions include the title bar and borders.

### Returns
- **Promise<PhysicalSize>** - The window’s outer size.

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

--------------------------------

### Get application bundle type

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the current application bundle type.

```typescript
import { getBundleType } from '@tauri-apps/api/app';
const type = await getBundleType();
```

--------------------------------

### listen()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Listen to an emitted event on this window.

```APIDOC
## listen<T>(event, handler)

### Description
Listen to an emitted event on this window.

### Parameters
- **event** (EventName) - Required - Event name. Must include only alphanumeric characters, -, /, : and _.
- **handler** (EventCallback<T>) - Required - Event handler.

### Returns
- **Promise<UnlistenFn>** - A promise resolving to a function to unlisten to the event.

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

--------------------------------

### show()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Shows the application on macOS. This function does not automatically focus any specific app window.

```APIDOC
## show()

### Description
Shows the application on macOS. This function does not automatically focus any specific app window.

### Returns
- **Promise<void>**

### Example
```javascript
import { show } from '@tauri-apps/api/app';
await show();
```
```

--------------------------------

### setTheme(theme?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Sets the application’s theme. Pass in null or undefined to follow the system theme.

```APIDOC
## setTheme(theme?)

### Description
Sets the application’s theme. Pass in null or undefined to follow the system theme.

### Parameters
- **theme** (null | Theme) - Optional - The theme to set.

### Returns
- **Promise<void>**

### Example
```javascript
import { setTheme } from '@tauri-apps/api/app';
await setTheme('dark');
```
```

--------------------------------

### getById(id)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacetray

Gets a tray icon by its ID.

```APIDOC
## getById(id)

### Description
Gets a tray icon using the provided id.

### Parameters
- **id** (string) - Required - The ID of the tray icon.

### Returns
- **Promise<null | TrayIcon>**
```

--------------------------------

### getAllWebviewWindows()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves a list of all available webview window instances.

```APIDOC
## getAllWebviewWindows()

### Description
Gets a list of instances of Webview for all available webview windows.

### Signature
`function getAllWebviewWindows(): Promise<WebviewWindow[]>`

### Returns
- `Promise<WebviewWindow[]>` - A promise that resolves to an array of WebviewWindow instances.

### Since
2.0.0
```

--------------------------------

### Prepend menu item

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Adds a menu item to the start of the submenu. On macOS, only submenus are supported for addition to a menu.

```typescript
prepend<T>(items): Promise<void>
```

--------------------------------

### popup(at?, window?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Displays the menu as a context menu.

```APIDOC
## popup(at?, window?)

### Description
Popup this menu as a context menu on the specified window.

### Parameters
- **at** (LogicalPosition | PhysicalPosition | Position) - Optional - If provided, the position is relative to the window's top-left corner. If not provided, the menu pops up at the current mouse location.
- **window** (Window) - Optional - The window to display the context menu on.
```

--------------------------------

### isMinimizable()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s native minimize button state. Note: Unsupported on Linux, iOS, and Android.

```APIDOC
## isMinimizable()

### Description
Gets the window’s native minimize button state.

### Returns
- **Promise<boolean>** - Whether the window’s native minimize button is enabled or not.

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

--------------------------------

### getAll()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieves a list of all available webview instances.

```APIDOC
## getAll()

### Description
Gets a list of instances of `Webview` for all available webviews.

### Returns
- **Promise<Webview[]>** - A list of all webview instances.
```

--------------------------------

### Mocking multiple windows

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Initializes mocked windows with specific labels to simulate a multi-window environment.

```javascript
import { mockWindows } from "@tauri-apps/api/mocks";
import { getCurrentWindow } from "@tauri-apps/api/window";


mockWindows("main", "second", "third");


const win = getCurrentWindow();


win.label // "main"
```

--------------------------------

### listen()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Registers an event listener for the webview.

```APIDOC
## listen<T>(event, handler)

### Description
Listen to an emitted event on this webview.

### Parameters
- **event** (EventName) - Required - Event name. Must include only alphanumeric characters, -, /, : and _.
- **handler** (EventCallback<T>) - Required - Event handler.

### Returns
- **Promise<UnlistenFn>** - A promise resolving to a function to unlisten to the event.

### Example
```javascript
import { getCurrentWebview } from '@tauri-apps/api/webview';
const unlisten = await getCurrentWebview().listen<string>('state-changed', (event) => {
  console.log(`Got error: ${payload}`);
});

unlisten();
```
```

--------------------------------

### isMaximizable()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s native maximize button state. Note: Unsupported on Linux, iOS, and Android.

```APIDOC
## isMaximizable()

### Description
Gets the window’s native maximize button state.

### Returns
- **Promise<boolean>** - Whether the window’s native maximize button is enabled or not.

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

--------------------------------

### default()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Creates a default menu.

```APIDOC
## default()

### Description
Create a default menu.

### Returns
- **Promise** (Promise<Menu>) - The created default menu.
```

--------------------------------

### Show window

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Sets the window visibility to true.

```typescript
show(): Promise<void>
```

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

--------------------------------

### Get Window Title

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the current title of the window.

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

--------------------------------

### mockWindows(current, ..._additionalWindows)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Mocks the window environment by defining the current window label and any additional windows available in the application context.

```APIDOC
## mockWindows(current, ..._additionalWindows)

### Description
Mocks the window environment for testing purposes. This function sets the label of the current window and registers additional windows that the application can interact with.

### Parameters
- **current** (string) - Required - Label of window this JavaScript context is running in.
- **..._additionalWindows** (string[]) - Optional - Additional window labels to mock.

### Returns
- **void**

### Since
1.0.0
```

--------------------------------

### isFocused()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets the window’s current focus state.

```APIDOC
## isFocused()

### Description
Gets the window’s current focus state.

### Returns
- **Promise<boolean>** - Whether the window is focused or not.

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

--------------------------------

### PredefinedMenuItem Methods

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Methods for managing the lifecycle, text content, and creation of predefined menu items.

```typescript
close(): Promise<void>
```

```typescript
setText(text): Promise<void>
```

```typescript
text(): Promise<string>
```

```typescript
static new(opts?): Promise<PredefinedMenuItem>
```

--------------------------------

### getAll()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Returns a list of all available webview instances.

```typescript

static getAll(): Promise<Webview[]>

```

--------------------------------

### setAsWindowMenu(window?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Sets the window menu and returns the previous one.

```APIDOC
## setAsWindowMenu(window?)

### Description
Sets the window menu and returns the previous one. Note: On macOS, this is unsupported as the menu is app-wide.

### Parameters
- **window** (Window) - Optional - The window to set the menu for.

### Returns
- **Promise** (Promise<null | Menu>) - The previous menu.
```

--------------------------------

### setFullscreen(fullscreen)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Sets the window fullscreen state.

```APIDOC
## setFullscreen(fullscreen)

### Description
Sets the window fullscreen state.

### Parameters
- **fullscreen** (boolean) - Required - Whether the window should go to fullscreen or not.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### Set window theme

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Configures the window theme, or passes null/undefined to follow the system theme. Note that this is app-wide on Linux and macOS.

```typescript
setTheme(theme?): Promise<void>
```

--------------------------------

### isMinimized()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s current minimized state.

```APIDOC
## isMinimized()

### Description
Gets the window’s current minimized state.

### Returns
- **Promise<boolean>** - Whether the window is minimized or not.

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

--------------------------------

### isMaximized()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Gets the window’s current maximized state.

```APIDOC
## isMaximized()

### Description
Gets the window’s current maximized state.

### Returns
- **Promise<boolean>** - Whether the window is maximized or not.

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

--------------------------------

### listen<T>(event, handler, options?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceevent

Listen to an emitted event to any target.

```APIDOC
## listen<T>(event, handler, options?)

### Description
Listen to an emitted event to any target.

### Parameters
- **event** (EventName) - Required - Event name. Must include only alphanumeric characters, -, /, : and _.
- **handler** (EventCallback<T>) - Required - Event handler callback.
- **options** (Options) - Optional - Event listening options.

### Returns
- **Promise<UnlistenFn>** - A promise resolving to a function to unlisten to the event.

### Example
```javascript
import { listen } from '@tauri-apps/api/event';
const unlisten = await listen<string>('error', (event) => {
  console.log(`Got error, payload: ${event.payload}`);
});
unlisten();
```
```

--------------------------------

### getTauriVersion()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Gets the Tauri framework version used by this application.

```APIDOC
## getTauriVersion()

### Description
Gets the Tauri framework version used by this application.

### Returns
- **Promise<string>** - The Tauri version string.

### Example
```javascript
import { getTauriVersion } from '@tauri-apps/api/app';
const tauriVersion = await getTauriVersion();
```
```

--------------------------------

### appConfigDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the suggested directory for your app’s config files.

```APIDOC
## appConfigDir()

### Description
Returns the path to the suggested directory for your app’s config files. Resolves to `${configDir}/${bundleIdentifier}`.

### Returns
- **Promise<string>** - The path to the config directory.

### Example
```javascript
import { appConfigDir } from '@tauri-apps/api/path';
const appConfigDirPath = await appConfigDir();
```
```

--------------------------------

### Get monitor from point

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Finds the monitor containing the specified coordinates.

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

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

--------------------------------

### Submenu.new()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Creates a new submenu instance.

```APIDOC
## static new(opts)

### Description
Create a new submenu.

### Parameters
- **opts** (SubmenuOptions) - Required - Options for the new submenu.

### Returns
- **Promise<Submenu>** - A promise that resolves to the new Submenu instance.
```

--------------------------------

### availableMonitors()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Returns the list of all the monitors available on the system.

```APIDOC
## availableMonitors()

### Description
Returns the list of all the monitors available on the system.

### Returns
- Promise<Monitor[]> - A promise that resolves to an array of available monitors.

### Example
```javascript
import { availableMonitors } from '@tauri-apps/api/window';
const monitors = await availableMonitors();
```
```

--------------------------------

### Get Scene Identifier

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the unique identifier for the window scene.

```typescript

sceneIdentifier(): Promise<string>

```

--------------------------------

### Retrieve System Audio Directory

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Resolves the path to the user's audio directory, which varies by platform.

```typescript
import { audioDir } from '@tauri-apps/api/path';
const audioDirPath = await audioDir();
```

--------------------------------

### Get MenuItem ID

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves the unique identifier for the menu item.

```typescript

get id(): string

```

--------------------------------

### isClosable()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Gets the window’s native close button state.

```APIDOC
## isClosable()

### Description
Gets the window’s native close button state. Note that this is unsupported on iOS and Android.

### Returns
- **Promise<boolean>** - Whether the window’s native close button is enabled or not.

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

--------------------------------

### audioDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s audio directory.

```APIDOC
## audioDir()

### Description
Returns the path to the user’s audio directory based on the operating system.

### Returns
- **Promise<string>** - The path to the audio directory.

### Example
```javascript
import { audioDir } from '@tauri-apps/api/path';
const audioDirPath = await audioDir();
```
```

--------------------------------

### new LogicalSize(width, height)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacedpi

Creates a new instance of LogicalSize using width and height values.

```APIDOC
## new LogicalSize(width, height)

### Description
Creates a new LogicalSize instance representing dimensions in logical pixels.

### Parameters
- **width** (number) - Required
- **height** (number) - Required

### Returns
- **LogicalSize**
```

--------------------------------

### Get CheckMenuItem ID

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves the unique identifier for the menu item.

```typescript
get id(): string
```

--------------------------------

### Get application identifier

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the application identifier defined in tauri.conf.json.

```typescript
import { getIdentifier } from '@tauri-apps/api/app';
const identifier = await getIdentifier();
```

--------------------------------

### cursorPosition()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Get the cursor position relative to the top-left hand corner of the desktop.

```APIDOC
## cursorPosition()

### Description
Get the cursor position relative to the top-left hand corner of the desktop.

### Returns
- Promise<PhysicalPosition> - A promise that resolves to the physical position of the cursor.
```

--------------------------------

### Manual Size Serialization

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacedpi

Demonstrates the manual approach to serializing size types before the Size class was available.

```typescript

import { invoke } from '@tauri-apps/api/core';
import { LogicalSize, PhysicalSize } from '@tauri-apps/api/dpi';


const size: LogicalSize | PhysicalSize = someFunction(); // where someFunction returns either LogicalSize or PhysicalSize
const validSize = size instanceof LogicalSize
  ? { Logical: { width: size.width, height: size.height } }
  : { Physical: { width: size.width, height: size.height } }
await invoke("do_something_with_size", { size: validSize });

```

--------------------------------

### outerPosition()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Get the position of the top-left hand corner of the window relative to the desktop.

```APIDOC
## outerPosition()

### Description
The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

### Returns
- **Promise<PhysicalPosition>** - The window’s outer position.

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

--------------------------------

### videoDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s video directory.

```APIDOC
## videoDir()

### Description
Returns the path to the user’s video directory.

### Returns
- **Promise<string>** - A promise that resolves to the video directory path.

### Example
```javascript
import { videoDir } from '@tauri-apps/api/path';
const videoDirPath = await videoDir();
```
```

--------------------------------

### Get current webview

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieves the Webview instance associated with the current context.

```typescript
function getCurrentWebview(): Webview
```

--------------------------------

### Retrieve Video Directory Path

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user's video directory.

```typescript

function videoDir(): Promise<string>

```

```typescript

import { videoDir } from '@tauri-apps/api/path';
const videoDirPath = await videoDir();

```

--------------------------------

### mockWindows(current, ...additionalWindows)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Mocks the presence of one or more window labels. This is required in non-Tauri contexts before using the @tauri-apps/api/window module.

```APIDOC
## mockWindows(current, ...additionalWindows)

### Description
Mocks the presence of window labels. Note that this only mocks presence; specific window properties should be mocked via `mockIPC`.

### Parameters
- **current** (string) - Required - The primary window label.
- **...additionalWindows** (string[]) - Optional - Additional window labels to mock.

### Returns
- **void**
```

--------------------------------

### Get default window icon

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the default window icon as a Promise.

```typescript
import { defaultWindowIcon } from '@tauri-apps/api/app';
const icon = await defaultWindowIcon();
```

--------------------------------

### MenuItem.new()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Creates a new menu item instance.

```APIDOC
## static new(opts)

### Description
Create a new menu item.

### Parameters
- **opts** (MenuItemOptions) - Required - Options for the new menu item.

### Returns
- **Promise<MenuItem>** - A promise that resolves to the new MenuItem instance.
```

--------------------------------

### isAlwaysOnTop()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Checks if the window is configured to be always on top.

```APIDOC
## isAlwaysOnTop()

### Description
Whether the window is configured to be always on top of other windows or not.

### Returns
- **Promise<boolean>** - Whether the window is visible or not.

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

--------------------------------

### getAllWebviews()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieves a list of all available webview instances.

```APIDOC
## getAllWebviews()

### Description
Gets a list of instances of `Webview` for all available webviews.

### Returns
- `Promise<Webview[]>` - A promise that resolves to an array of Webview instances.

### Since
2.0.0
```

--------------------------------

### Get cursor position

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Returns the cursor position relative to the top-left corner of the desktop.

```typescript
function cursorPosition(): Promise<PhysicalPosition>
```

--------------------------------

### supportsMultipleWindows()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Checks if the application supports multiple windows.

```APIDOC
## supportsMultipleWindows()

### Description
Checks if the application supports multiple windows.

### Returns
- **Promise<boolean>**
```

--------------------------------

### Get MenuItem Resource ID

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves the internal resource identifier for the menu item.

```typescript

get rid(): number

```

--------------------------------

### Mock window labels

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Use mockWindows to define window labels before interacting with the window module in non-Tauri environments.

```typescript
function mockWindows(current, ..._additionalWindows): void
```

--------------------------------

### downloadDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s download directory.

```APIDOC
## downloadDir()

### Description
Returns the path to the user’s download directory.

### Returns
- **Promise<string>** - The path to the download directory.

### Example
```javascript
import { downloadDir } from '@tauri-apps/api/path';
const downloadDirPath = await downloadDir();
```
```

--------------------------------

### Get Current Webview

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieve the Webview instance associated with the current execution context.

```typescript
static getCurrent(): Webview
```

--------------------------------

### Set as macOS Help menu

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Configures the submenu as the Help menu on macOS, enabling the automatic search box. This is unsupported on Windows and Linux.

```typescript
setAsHelpMenuForNSApp(): Promise<void>
```

--------------------------------

### Get Menu Item Text

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves the current display text of the menu item.

```typescript
text(): Promise<string>
```

--------------------------------

### setFocus()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Brings the webview to the front and sets focus to it.

```APIDOC
## setFocus()

### Description
Bring the webview to front and focus.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.
```

--------------------------------

### Get webview position

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Retrieves the coordinates of the top-left corner of the webview relative to the desktop.

```typescript
position(): Promise<PhysicalPosition>
```

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

--------------------------------

### Show Application

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Displays the application on macOS without automatically focusing a specific window.

```typescript
function show(): Promise<void>
```

```typescript
import { show } from '@tauri-apps/api/app';
await show();
```

--------------------------------

### Get Tauri framework version

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Retrieves the version of the Tauri framework currently in use.

```typescript
import { getTauriVersion } from '@tauri-apps/api/app';
const tauriVersion = await getTauriVersion();
```

--------------------------------

### Set visibility on all workspaces

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Configures whether the window appears on all virtual desktops. Note that this is unsupported on Windows, iOS, and Android.

```typescript
setVisibleOnAllWorkspaces(visible): Promise<void>
```

--------------------------------

### Get current monitor

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves the monitor where the current window resides, returning null if not detected.

```typescript
function currentMonitor(): Promise<Monitor | null>
```

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

--------------------------------

### pictureDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s picture directory.

```APIDOC
## pictureDir()

### Description
Returns the path to the user’s picture directory. The result is platform-specific.

### Returns
- **Promise<string>** - The path to the picture directory.

### Example
```javascript
import { pictureDir } from '@tauri-apps/api/path';
const pictureDirPath = await pictureDir();
```
```

--------------------------------

### Get submenu items

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Retrieves a list of all menu items currently contained within the submenu.

```typescript
items(): Promise<(
  | MenuItem
  | PredefinedMenuItem
  | Submenu
  | CheckMenuItem
| IconMenuItem)[]>
```

--------------------------------

### mockIPC(cb, options?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Mocks IPC commands to simulate backend responses. The callback receives the command name and payload, and can return a value or a Promise.

```APIDOC
## mockIPC(cb, options?)

### Description
Mocks IPC commands. The callback function handles incoming commands and payloads, returning the desired result. Optionally supports event mocking via the `shouldMockEvents` option.

### Parameters
- **cb** (function) - Required - Callback function with signature `(cmd, payload?) => unknown`.
- **options** (MockIPCOptions) - Optional - Configuration object, including `shouldMockEvents` to enable event mocking.

### Returns
- **void**
```

--------------------------------

### Get Inner Position

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves the position of the window's client area relative to the desktop.

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

--------------------------------

### appDataDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the suggested directory for your app’s data files.

```APIDOC
## appDataDir()

### Description
Returns the path to the suggested directory for your app’s data files. Resolves to `${dataDir}/${bundleIdentifier}`.

### Returns
- **Promise<string>** - The path to the data directory.

### Example
```javascript
import { appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
```
```

--------------------------------

### Get Scale Factor

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the scale factor used to map physical pixels to logical pixels.

```typescript

scaleFactor(): Promise<number>

```

```typescript

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

```

--------------------------------

### setDecorations(decorations: boolean): Promise<void>

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Sets whether the window should have borders and bars.

```APIDOC
## setDecorations(decorations)

### Description
Sets whether the window should have borders and bars.

### Parameters
- **decorations** (boolean) - Required - Whether the window should have borders and bars.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### Get outer window size

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the physical size of the window, including title bars and borders.

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

--------------------------------

### setAsHelpMenuForNSApp()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Set this submenu as the Help menu for the application on macOS.

```APIDOC
## setAsHelpMenuForNSApp()

### Description
Set this submenu as the Help menu for the application on macOS. This will cause macOS to automatically add a search box to the menu. Unsupported on Windows/Linux.

### Returns
- **Promise<void>** - A promise that resolves when the menu is set.
```

--------------------------------

### Get local data directory

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Retrieves the platform-specific path to the user's local data directory.

```typescript

function localDataDir(): Promise<string>

```

```typescript

import { localDataDir } from '@tauri-apps/api/path';
const localDataDirPath = await localDataDir();

```

--------------------------------

### executableDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s executable directory.

```APIDOC
## executableDir()

### Description
Returns the path to the user’s executable directory.

### Returns
- **Promise<string>** - The path to the executable directory.

### Example
```javascript
import { executableDir } from '@tauri-apps/api/path';
const executableDirPath = await executableDir();
```
```

--------------------------------

### homeDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s home directory.

```APIDOC
## homeDir()

### Description
Returns the path to the user’s home directory.

### Returns
- **Promise<string>** - The path to the home directory.

### Example
```javascript
import { homeDir } from '@tauri-apps/api/path';
const homeDirPath = await homeDir();
```
```

--------------------------------

### Clear Mocks Usage Example

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemocks

Demonstrates resetting Tauri-specific properties after each test using a test runner.

```typescript

import { mockWindows, clearMocks } from "@tauri-apps/api/mocks"


afterEach(() => {
   clearMocks()
})


test("mocked windows", () => {
   mockWindows("main", "second", "third");


   expect(window.__TAURI_INTERNALS__).toHaveProperty("metadata")
})


test("no mocked windows", () => {
   expect(window.__TAURI_INTERNALS__).not.toHaveProperty("metadata")
})

```

--------------------------------

### Get outer window position

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Retrieves the window's position relative to the desktop's top-left corner.

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

--------------------------------

### Get Path Segment Separator

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the platform-specific path separator, providing '\' for Windows and '/' for POSIX systems.

```typescript

function sep(): string

```

--------------------------------

### runtimeDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s runtime directory.

```APIDOC
## runtimeDir()

### Description
Returns the path to the user’s runtime directory. Note that this is not supported on macOS or Windows.

### Returns
- **Promise<string>** - A promise that resolves to the runtime directory path.

### Example
```javascript
import { runtimeDir } from '@tauri-apps/api/path';
const runtimeDirPath = await runtimeDir();
```
```

--------------------------------

### Get Inner Size

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewindow

Retrieves the physical dimensions of the window's client area, excluding borders and title bars.

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

--------------------------------

### setTitle(title)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacetray

Sets the title for the tray icon.

```APIDOC
## setTitle(title)

### Description
Sets the title for this tray icon.

### Parameters
- **title** (null | string) - Required - The title to set.

### Returns
- **Promise<void>**
```

--------------------------------

### setEffects(effects: Effects): Promise<void>

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Set window effects.

```APIDOC
## setEffects(effects)

### Description
Set window effects.

### Parameters
- **effects** (Effects) - Required - The effects to apply to the window.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.
```

--------------------------------

### once<T>(event, handler, options?)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceevent

Listens once to an emitted event to any target.

```APIDOC
## once<T>(event, handler, options?)

### Description
Listens once to an emitted event to any target.

### Parameters
- **event** (EventName) - Required - Event name. Must include only alphanumeric characters, -, /, : and _.
- **handler** (EventCallback<T>) - Required - Event handler callback.
- **options** (Options) - Optional - Event listening options.

### Returns
- **Promise<UnlistenFn>** - A promise resolving to a function to unlisten to the event.

### Example
```javascript
import { once } from '@tauri-apps/api/event';
const unlisten = await once<LoadedPayload>('loaded', (event) => {
  console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);
});
unlisten();
```
```

--------------------------------

### Create new MenuItem

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Static method to instantiate a new menu item with provided options.

```typescript

static new(opts): Promise<MenuItem>

```

--------------------------------

### setShadow(enable)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Configures whether the window should have a shadow.

```APIDOC
## setShadow(enable)

### Description
Whether or not the window should have shadow.

### Parameters
- **enable** (boolean) - Enable or disable the window shadow.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

### Example
```javascript
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setShadow(false);
```
```

--------------------------------

### reparent(window)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebview

Moves the current webview to a different window.

```APIDOC
## reparent(window)

### Description
Moves this webview to the given label.

### Parameters
- **window** (string | Window | WebviewWindow) - Required - The target window label or instance.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.
```

--------------------------------

### setTitle(title)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Sets the window title.

```APIDOC
## setTitle(title)

### Description
Sets the window title.

### Parameters
- **title** (string) - Required - The new title.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### prepend<T>(items)

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Adds a menu item to the beginning of the menu.

```APIDOC
## prepend<T>(items)

### Description
Add a menu item to the beginning of this menu. Platform-specific: on macOS, only Submenus can be added to a Menu.

### Parameters
- **items** (T | T[]) - Required - The menu item or items to prepend.
```

--------------------------------

### Set Application Theme

Source: https://tauri.app/zh-cn/reference/javascript/api/namespaceapp

Configures the application theme. Passing null or undefined reverts to the system theme; unsupported on iOS and Android.

```typescript
function setTheme(theme?): Promise<void>
```

```typescript
import { setTheme } from '@tauri-apps/api/app';
await setTheme('dark');
```

--------------------------------

### PredefinedMenuItem.setText()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacemenu

Sets the text for a predefined menu item.

```APIDOC
## setText(text)

### Description
Sets the text for this predefined menu item.

### Parameters
- **text** (string) - Required - The text to set.

### Returns
- **Promise<void>**
```

--------------------------------

### maximize()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Maximizes the window.

```APIDOC
## maximize()

### Description
Maximizes the window.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### Initialize PhysicalSize with object

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacedpi

Construct a new PhysicalSize instance using an object containing width and height properties.

```typescript

new PhysicalSize(object): PhysicalSize

```

```typescript

new PhysicalSize(object): PhysicalSize

```

--------------------------------

### templateDir()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Returns the path to the user’s template directory.

```APIDOC
## templateDir()

### Description
Returns the path to the user’s template directory. This is not supported on macOS.

### Returns
- **Promise<string>** - A promise that resolves to the template directory path.

### Example
```javascript
import { templateDir } from '@tauri-apps/api/path';
const templateDirPath = await templateDir();
```
```

--------------------------------

### minimize()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacewebviewwindow

Minimizes the window.

```APIDOC
## minimize()

### Description
Minimizes the window.

### Returns
- **Promise<void>** - A promise indicating the success or failure of the operation.

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

--------------------------------

### join()

Source: https://tauri.app/zh-cn/reference/javascript/api/namespacepath

Joins all given path segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.

```APIDOC
## join(...paths)

### Description
Joins all given `path` segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.

### Parameters
- **paths** (string[]) - Required - The path segments to join.

### Returns
- **Promise<string>** - The joined and normalized path.

### Example
```javascript
import { join, appDataDir } from '@tauri-apps/api/path';
const appDataDirPath = await appDataDir();
const path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');
```
```
Tokens:
Raw