app

Enumerations

BundleType

Defined in: packages/api/src/app.ts:36

Bundle type of the current application.

Enumeration Members

App

App: "app";

Defined in: packages/api/src/app.ts:48

macOS app bundle

AppImage

AppImage: "appimage";

Defined in: packages/api/src/app.ts:46

Linux AppImage

Deb

Deb: "deb";

Defined in: packages/api/src/app.ts:42

Linux Debian package

Msi

Msi: "msi";

Defined in: packages/api/src/app.ts:40

Windows MSI

Nsis

Nsis: "nsis";

Defined in: packages/api/src/app.ts:38

Windows NSIS

Rpm

Rpm: "rpm";

Defined in: packages/api/src/app.ts:44

Linux RPM

Type Aliases

DataStoreIdentifier

type DataStoreIdentifier = [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];

Defined in: packages/api/src/app.ts:14

Identifier type used for data stores on macOS and iOS.

Represents a 128-bit identifier, commonly expressed as a 16-byte UUID.

---

OnBackButtonPressPayload

type OnBackButtonPressPayload = object;

Defined in: packages/api/src/app.ts:258

Payload for the onBackButtonPress event.

Properties

Property	Type	Description	Defined in
canGoBack	boolean	Whether the webview canGoBack property is true.	packages/api/src/app.ts:260

Functions

defaultWindowIcon()

function defaultWindowIcon(): Promise<Image | null>;

Defined in: packages/api/src/app.ts:197

Gets the default window icon.

Returns

Promise<Image | null>

Example

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

Since

2.0.0

---

fetchDataStoreIdentifiers()

function fetchDataStoreIdentifiers(): Promise<DataStoreIdentifier[]>;

Defined in: packages/api/src/app.ts:160

Fetches the data store identifiers on macOS and iOS.

See https://developer.apple.com/documentation/webkit/wkwebsitedatastore for more information.

Returns

Promise<DataStoreIdentifier[]>

Example

import { fetchDataStoreIdentifiers } from '@tauri-apps/api/app';
const ids = await fetchDataStoreIdentifiers();

Since

2.4.0

---

getBundleType()

function getBundleType(): Promise<BundleType>;

Defined in: packages/api/src/app.ts:251

Gets the application bundle type.

Returns

Promise<BundleType>

Example

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

Since

2.5.0

---

getIdentifier()

function getIdentifier(): Promise<string>;

Defined in: packages/api/src/app.ts:112

Gets the application identifier.

Returns

Promise<string>

The application identifier as configured in tauri.conf.json.

Example

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

Since

2.4.0

---

getName()

function getName(): Promise<string>;

Defined in: packages/api/src/app.ts:81

Gets the application name.

Returns

Promise<string>

Example

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

Since

1.0.0

---

getTauriVersion()

function getTauriVersion(): Promise<string>;

Defined in: packages/api/src/app.ts:96

Gets the Tauri framework version used by this application.

Returns

Promise<string>

Example

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

Since

1.0.0

---

getVersion()

function getVersion(): Promise<string>;

Defined in: packages/api/src/app.ts:67

Gets the application version.

Returns

Promise<string>

Example

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

Since

1.0.0

---

hide()

function hide(): Promise<void>;

Defined in: packages/api/src/app.ts:143

Hides the application on macOS.

Returns

Promise<void>

Example

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

Since

1.2.0

---

onBackButtonPress()

function onBackButtonPress(handler): Promise<PluginListener>;

Defined in: packages/api/src/app.ts:267

Listens to the backButton event on Android.

Parameters

Parameter	Type	Description
handler	(payload) => void	-

Returns

Promise<PluginListener>

---

removeDataStore()

function removeDataStore(uuid): Promise<void>;

Defined in: packages/api/src/app.ts:181

Removes the data store with the given identifier.

Note that any webview using this data store should be closed before running this API.

See https://developer.apple.com/documentation/webkit/wkwebsitedatastore for more information.

Parameters

Parameter	Type
uuid	DataStoreIdentifier

Returns

Promise<void>

Example

import { fetchDataStoreIdentifiers, removeDataStore } from '@tauri-apps/api/app';
for (const id of (await fetchDataStoreIdentifiers())) {
  await removeDataStore(id);
}

Since

2.4.0

---

setDockVisibility()

function setDockVisibility(visible): Promise<void>;

Defined in: packages/api/src/app.ts:236

Sets the dock visibility for the application on macOS.

Parameters

Parameter	Type	Description
visible	boolean	Whether the dock should be visible or not.

Returns

Promise<void>

Example

import { setDockVisibility } from '@tauri-apps/api/app';
await setDockVisibility(false);

Since

2.5.0

---

setTheme()

function setTheme(theme?): Promise<void>;

Defined in: packages/api/src/app.ts:219

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

Parameters

Parameter	Type
theme?	Theme | null

Returns

Promise<void>

Example

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

Platform-specific

• iOS / Android: Unsupported.

Since

2.0.0

---

show()

function show(): Promise<void>;

Defined in: packages/api/src/app.ts:128

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

Returns

Promise<void>

Example

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

Since

1.2.0

---

supportsMultipleWindows()

function supportsMultipleWindows(): Promise<boolean>;

Defined in: packages/api/src/app.ts:277

Returns

Promise<boolean>