event
Ce contenu n’est pas encore disponible dans votre langue.
The event system allows you to emit events to the backend and listen to events from it.
This package is also accessible with window.__TAURI__.event
when app.withGlobalTauri
in tauri.conf.json
is set to true
.
1.1.0
DRAG_DROP: "tauri://drag-drop";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L71
DRAG_ENTER: "tauri://drag-enter";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L69
DRAG_LEAVE: "tauri://drag-leave";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L72
DRAG_OVER: "tauri://drag-over";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L70
WEBVIEW_CREATED: "tauri://webview-created";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L68
WINDOW_BLUR: "tauri://blur";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L64
WINDOW_CLOSE_REQUESTED: "tauri://close-requested";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L61
WINDOW_CREATED: "tauri://window-created";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L67
WINDOW_DESTROYED: "tauri://destroyed";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L62
WINDOW_FOCUS: "tauri://focus";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L63
WINDOW_MOVED: "tauri://move";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L60
WINDOW_RESIZED: "tauri://resize";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L59
WINDOW_SCALE_FACTOR_CHANGED: "tauri://scale-change";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L65
WINDOW_THEME_CHANGED: "tauri://theme-changed";
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L66
Type Parameter |
---|
T |
Property | Type | Description | Defined in |
---|---|---|---|
event | EventName | Event name | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L32 |
id | number | Event identifier used to unlisten | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L34 |
payload | T | Event payload | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L36 |
Property | Type | Description | Defined in |
---|---|---|---|
target? | string | EventTarget | The event target to listen to, defaults to { kind: 'Any' } , see EventTarget. If a string is provided, EventTarget.AnyLabel is used. | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L52 |
type EventCallback<T>: (event) => void;
Type Parameter |
---|
T |
Parameter | Type |
---|---|
event | Event <T > |
void
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L39
type EventName: `${TauriEvent}` | string & Record<never, never>;
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L44
type EventTarget: | object | object | object | object | object | object;
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L22
type UnlistenFn: () => void;
void
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L42
function emit<T>(event, payload?): Promise<void>
Emits an event to all targets.
Type Parameter |
---|
T |
Parameter | Type | Description |
---|---|---|
event | string | Event name. Must include only alphanumeric characters, - , / , : and _ . |
payload ? | T | Event payload. |
Promise
<void
>
import { emit } from '@tauri-apps/api/event';await emit('frontend-loaded', { loggedIn: true, token: 'authToken' });
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L186
function emitTo<T>( target, event,payload?): Promise<void>
Emits an event to all targets matching the given target.
Type Parameter |
---|
T |
Parameter | Type | Description |
---|---|---|
target | string | EventTarget | Label of the target Window/Webview/WebviewWindow or raw EventTarget object. |
event | string | Event name. Must include only alphanumeric characters, - , / , : and _ . |
payload ? | T | Event payload. |
Promise
<void
>
import { emitTo } from '@tauri-apps/api/event';await emitTo('main', 'frontend-loaded', { loggedIn: true, token: 'authToken' });
2.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L208
function listen<T>( event, handler,options?): Promise<UnlistenFn>
Listen to an emitted event to any target.
Type Parameter |
---|
T |
Parameter | Type | Description |
---|---|---|
event | EventName | Event name. Must include only alphanumeric characters, - , / , : and _ . |
handler | EventCallback <T > | Event handler callback. |
options ? | Options | Event listening options. |
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
import { listen } from '@tauri-apps/api/event';const unlisten = await listen<string>('error', (event) => { console.log(`Got error, payload: ${event.payload}`);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L113
function once<T>( event, handler,options?): Promise<UnlistenFn>
Listens once to an emitted event to any target.
Type Parameter |
---|
T |
Parameter | Type | Description |
---|---|---|
event | EventName | Event name. Must include only alphanumeric characters, - , / , : and _ . |
handler | EventCallback <T > | Event handler callback. |
options ? | Options | Event listening options. |
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
import { once } from '@tauri-apps/api/event';interface LoadedPayload { loggedIn: boolean, token: string}const unlisten = await once<LoadedPayload>('loaded', (event) => { console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L157
© 2025 Tauri Contributors. CC-BY / MIT