A size represented in logical pixels. Logical pixels are scaled according to the window's DPI scale. Most browser APIs (i.e. MouseEvent's clientX) will return logical pixels.

LogicalSizeObject

external interface LogicalSizeObject

LogicalSizeObjectTemp

external interface LogicalSizeObjectTemp

LogicalSizeToJSONResult

external interface LogicalSizeToJSONResult

MenuIcon

typealias MenuIcon = Any

A type that represents an icon that can be used in menu items.

MockIPCOptions

external interface MockIPCOptions

Options for mockIPC.

Monitor

external interface Monitor

Allows you to retrieve information about a given monitor.

MonitorWorkArea

external interface MonitorWorkArea

MouseButton

sealed external interface MouseButton

MouseButtonState

sealed external interface MouseButtonState

OnBackButtonPressPayload

external interface OnBackButtonPressPayload

Payload for the onBackButtonPress event.

Options

external interface Options

PermissionState

sealed external interface PermissionState

PhysicalPosition

external class PhysicalPosition

A position represented in physical pixels.

PhysicalPositionObject

external interface PhysicalPositionObject

PhysicalPositionObjectTemp

external interface PhysicalPositionObjectTemp

PhysicalPositionToJSONResult

external interface PhysicalPositionToJSONResult

PhysicalSize

external class PhysicalSize

A size represented in physical pixels.

PhysicalSizeObject

external interface PhysicalSizeObject

PhysicalSizeObjectTemp

external interface PhysicalSizeObjectTemp

PhysicalSizeToJSONResult

external interface PhysicalSizeToJSONResult

PluginListener

external class PluginListener

Position

external class Position

A position represented either in physical or in logical pixels.

PositionToJSONResult

external interface PositionToJSONResult

PreventOverflowMargin

external interface PreventOverflowMargin

Minimum margin to work area

ProgressBarState

external interface ProgressBarState

ProgressBarStatus

sealed external interface ProgressBarStatus

ResizeDirection

sealed external interface ResizeDirection

Resource

open external class Resource

A rust-backed resource stored through tauri::Manager::resources_table API.

ScaleFactorChanged

external interface ScaleFactorChanged

The payload for the scaleChange event.

ScrollBarStyle

sealed external interface ScrollBarStyle

The scrollbar style to use in the webview.

Size

external class Size

A size represented either in physical or in logical pixels.

SizeToJSONResult

external interface SizeToJSONResult

TauriEvent

sealed external interface TauriEvent

Temp0

external interface Temp0

Temp1

external interface Temp1

Temp2

external interface Temp2

Temp3

external interface Temp3

Temp4

external interface Temp4

Temp5

external interface Temp5

Temp6

sealed external interface Temp6

Theme

sealed external interface Theme

TitleBarStyle

sealed external interface TitleBarStyle

TrayIcon

external class TrayIcon : Resource

Tray icon class and associated methods. This type constructor is private, instead, you should use the static method {@linkcode TrayIcon.new}.

TrayIconClickEvent

external interface TrayIconClickEvent

TrayIconEvent

typealias TrayIconEvent = Any

Describes a tray icon event.

TrayIconEventBase

external interface TrayIconEventBase<T : TrayIconEventType>

TrayIconEventBaseRect

external interface TrayIconEventBaseRect

TrayIconEventType

sealed external interface TrayIconEventType

TrayIconOptions

external interface TrayIconOptions

{@link TrayIcon.new|TrayIcon} creation options

UnlistenFn

typealias UnlistenFn = () -> Unit

UserAttentionType

sealed external interface UserAttentionType

Attention type to request on a window.

Webview

open external class Webview

Create new webview or get a handle to an existing one.

WebviewLabel

typealias WebviewLabel = String

WebviewOptions

external interface WebviewOptions

Configuration for the webview to create.

WebviewWindow

open external class WebviewWindow : Webview

WebviewWindowOptions

external interface WebviewWindowOptions : <ERROR CLASS> ERROR CLASS: Symbol not found for JsAny, WindowOptions

Window

open external class Window

Create new window or get a handle to an existing one.

Window__TAURI_EVENT_PLUGIN_INTERNALS__

external interface Window__TAURI_EVENT_PLUGIN_INTERNALS__

WindowLabel

typealias WindowLabel = String

WindowOptions

external interface WindowOptions

Configuration for the window to create.

WindowSizeConstraints

external interface WindowSizeConstraints

Properties

SERIALIZE_TO_IPC_FN

external val SERIALIZE_TO_IPC_FN: Any?

Functions

addPluginListener

external fun <T> addPluginListener(plugin: String, event: String, cb: (payload: T) -> Unit): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/PluginListener>

Adds a listener to a plugin event.

appCacheDir

external fun appCacheDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the suggested directory for your app's cache files. Resolves to ${cacheDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

appConfigDir

external fun appConfigDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the suggested directory for your app's config files. Resolves to ${configDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

appDataDir

external fun appDataDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the suggested directory for your app's data files. Resolves to ${dataDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

appLocalDataDir

external fun appLocalDataDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the suggested directory for your app's local data files. Resolves to ${localDataDir}/${bundleIdentifier}, where bundleIdentifier is the identifier value configured in tauri.conf.json.

appLogDir

external fun appLogDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the suggested directory for your app's log files.

audioDir

external fun audioDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's audio directory.

availableMonitors

external fun availableMonitors(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<tauri/apps/api/Monitor>>

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

basename

external fun basename(path: String, ext: String = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the last portion of a path. Trailing directory separators are ignored.

cacheDir

external fun cacheDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's cache directory.

checkPermissions

external fun <T> checkPermissions(plugin: String): ERROR CLASS: Symbol not found for js.promise.Promise<T>

Get permission state for a plugin.

clearMocks

external fun clearMocks()

Clears mocked functions/data injected by the other functions in this module. When using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.

configDir

external fun configDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's config directory.

convertFileSrc

external fun convertFileSrc(filePath: String, protocol: String = definedExternally): String

Convert a device file path to an URL that can be loaded by the webview. Note that asset: and http://asset.localhost must be added to app.security.csp in tauri.conf.json. Example CSP value: "csp": "default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost" to use the asset protocol on image sources.

currentMonitor

external fun currentMonitor(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/Monitor?>

Returns the monitor on which the window currently resides. Returns null if current monitor can't be detected.

cursorPosition

external fun cursorPosition(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/PhysicalPosition>

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

dataDir

external fun dataDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's data directory.

defaultWindowIcon

external fun defaultWindowIcon(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/Image?>

Gets the default window icon.

delimiter

external fun delimiter(): String

Returns the platform-specific path segment delimiter:

desktopDir

external fun desktopDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's desktop directory.

dirname

external fun dirname(path: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the parent directory of a given path. Trailing directory separators are ignored.

documentDir

external fun documentDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's document directory.

downloadDir

external fun downloadDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's download directory.

emit

external fun <T> emit(event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Emits an event to all {@link EventTarget|targets}.

emitTo

external fun <T> emitTo(target: EventTarget, event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

external fun <T> emitTo(target: String, event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Emits an event to all {@link EventTarget|targets} matching the given target.

executableDir

external fun executableDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's executable directory.

extname

external fun extname(path: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the extension of the path.

fetchDataStoreIdentifiers

external fun fetchDataStoreIdentifiers(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<{tauri/apps/api/DataStoreIdentifier=} ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Double>>>

Fetches the data store identifiers on macOS and iOS.

fontDir

external fun fontDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's font directory.

getAllWebviews

external fun getAllWebviews(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<tauri/apps/api/Webview>>

Gets a list of instances of Webview for all available webviews.

getAllWebviewWindows

external fun getAllWebviewWindows(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<tauri/apps/api/WebviewWindow>>

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

getAllWindows

external fun getAllWindows(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.array.ReadonlyArray<tauri/apps/api/Window>>

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

getBundleType

external fun getBundleType(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/BundleType>

Gets the application bundle type.

getCurrentWebview

external fun getCurrentWebview(): Webview

Get an instance of Webview for the current webview.

getCurrentWebviewWindow

external fun getCurrentWebviewWindow(): WebviewWindow

Get an instance of Webview for the current webview window.

getCurrentWindow

external fun getCurrentWindow(): Window

Get an instance of Window for the current window.

getIdentifier

external fun getIdentifier(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Gets the application identifier.

getName

external fun getName(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Gets the application name.

getTauriVersion

external fun getTauriVersion(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Gets the Tauri framework version used by this application.

getVersion

external fun getVersion(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Gets the application version.

hide

external fun hide(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Hides the application on macOS.

homeDir

external fun homeDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's home directory.

invoke

external fun <T> invoke(cmd: String, args: InvokeArgs = definedExternally, options: InvokeOptions = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<T>

Sends a message to the backend.

isAbsolute

external fun isAbsolute(path: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/Boolean>

Returns whether the path is absolute or not.

isTauri

external fun isTauri(): Boolean

join

external fun join(vararg paths: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

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

listen

external fun <T> listen(event: EventName, handler: EventCallback<T>, options: Options = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<{tauri/apps/api/UnlistenFn=} kotlin/Function0<kotlin/Unit>>

Listen to an emitted event to any {@link EventTarget|target}.

localDataDir

external fun localDataDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's local data directory.

mockConvertFileSrc

external fun mockConvertFileSrc(osName: String)

Mock convertFileSrc function

mockIPC

external fun mockIPC(cb: (cmd: String, InvokeArgs?) -> Any?, options: MockIPCOptions = definedExternally)

Intercepts all IPC requests with the given mock handler.

mockWindows

external fun mockWindows(current: String, vararg _additionalWindows: String)

Mocks one or many window labels. In non-tauri context it is required to call this function before using the @tauri-apps/api/window module.

monitorFromPoint

external fun monitorFromPoint(x: Double, y: Double): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/Monitor?>

Returns the monitor that contains the given point. Returns null if can't find any.

normalize

external fun normalize(path: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Normalizes the given path, resolving '..' and '.' segments and resolve symbolic links.

onBackButtonPress

external fun onBackButtonPress(handler: (payload: OnBackButtonPressPayload) -> Unit): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/PluginListener>

Listens to the backButton event on Android.

once

external fun <T> once(event: EventName, handler: EventCallback<T>, options: Options = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<{tauri/apps/api/UnlistenFn=} kotlin/Function0<kotlin/Unit>>

Listens once to an emitted event to any {@link EventTarget|target}.

pictureDir

external fun pictureDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's picture directory.

primaryMonitor

external fun primaryMonitor(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/Monitor?>

Returns the primary monitor of the system. Returns null if it can't identify any monitor as a primary one.

publicDir

external fun publicDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's public directory.

removeDataStore

external fun removeDataStore(uuid: {tauri/apps/api/DataStoreIdentifier=} ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Double>): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Removes the data store with the given identifier.

requestPermissions

external fun <T> requestPermissions(plugin: String): ERROR CLASS: Symbol not found for js.promise.Promise<T>

Request permissions.

resolve

external fun resolve(vararg paths: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Resolves a sequence of paths or path segments into an absolute path.

resolveResource

external fun resolveResource(resourcePath: String): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Resolve the path to a resource file.

resourceDir

external fun resourceDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the application's resource directory. To resolve a resource path, see {@linkcode resolveResource}.

runtimeDir

external fun runtimeDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's runtime directory.

sep

external fun sep(): String

Returns the platform-specific path segment separator:

setDockVisibility

external fun setDockVisibility(visible: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the dock visibility for the application on macOS.

setTheme

external fun setTheme(theme: Theme? = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

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

show

external fun show(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

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

tempDir

external fun tempDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns a temporary directory.

templateDir

external fun templateDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's template directory.

transformCallback

external fun <T> transformCallback(callback: (response: T) -> Unit = definedExternally, once: Boolean = definedExternally): Double

Stores the callback in a known location, and returns an identifier that can be passed to the backend. The backend uses the identifier to eval() the callback.

transformImage

external fun <T> transformImage(image: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Double>??): T

external fun <T> transformImage(image: ERROR CLASS: Symbol not found for js.buffer.ArrayBuffer??): T

external fun <T> transformImage(image: ERROR CLASS: Symbol not found for js.typedarrays.Uint8Array<ERROR CLASS: Symbol not found for js.buffer.ArrayBuffer>??): T

external fun <T> transformImage(image: String?): T

external fun <T> transformImage(image: Image?): T

Transforms image from various types into a type acceptable by Rust.

videoDir

external fun videoDir(): ERROR CLASS: Symbol not found for js.promise.Promise<kotlin/String>

Returns the path to the user's video directory.