CalvinBackup/tauri
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2026-04-03 10:11:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(core): global events now reaches window listeners, closes #4493 (#7163)

Browse Source 
Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
This commit is contained in:
Lucas Fernandes Nogueira
2023-06-13 04:05:58 -07:00
committed by GitHub
parent 5d85d0990c
commit 696d77c3ce
7 changed files with 226 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
tooling/api/src/event.ts
View File

@@ -39,7 +39,8 @@ export enum TauriEvent {
}
/**
* Listen to an event from the backend.
* Listen to an event. The event can be either global or window-specific.
* See {@link Event.windowLabel} to check the event source.
*
* @example
* ```typescript
@@ -67,7 +68,7 @@ async function listen<T>(
}
/**
* Listen to an one-off event from the backend.
* Listen to an one-off event. See {@link listen} for more information.
*
* @example
* ```typescript
@@ -98,7 +99,7 @@ async function once<T>(
}
/**
* Emits an event to the backend.
* Emits an event to the backend and all Tauri windows.
* @example
* ```typescript
* import { emit } from '@tauri-apps/api/event';

38
tooling/api/src/window.ts
View File

@@ -326,7 +326,10 @@ class WebviewWindowHandle {
}
/**
* Listen to an event emitted by the backend that is tied to the webview window.
* Listen to an event emitted by the backend or webview.
* The event must either be a global event or an event targetting this window.
*
* See {@link WebviewWindow.emit | `emit`} for more information.
*
* @example
* ```typescript
@@ -339,10 +342,11 @@ class WebviewWindowHandle {
* unlisten();
* ```
*
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
*
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
* @param handler Event handler.
* @returns 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.
*/
async listen<T>(
event: EventName,
@@ -359,7 +363,8 @@ class WebviewWindowHandle {
}
/**
* Listen to an one-off event emitted by the backend that is tied to the webview window.
* Listen to an one-off event.
* See {@link WebviewWindow.listen | `listen`} for more information.
*
* @example
* ```typescript
@@ -372,10 +377,11 @@ class WebviewWindowHandle {
* unlisten();
* ```
*
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
*
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
* @param handler Event handler.
* @returns 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.
*/
async once<T>(event: string, handler: EventCallback<T>): Promise<UnlistenFn> {
if (this._handleTauriEvent(event, handler)) {
@@ -389,13 +395,35 @@ class WebviewWindowHandle {
}
/**
* Emits an event to the backend, tied to the webview window.
* Emits an event to the backend and all Tauri windows.
* The event will have this window's {@link WebviewWindow.label | label} as {@link Event.windowLabel | source window label}.
*
* @example
* ```typescript
* import { appWindow } from '@tauri-apps/api/window';
* await appWindow.emit('window-loaded', { loggedIn: true, token: 'authToken' });
* ```
*
* This function can also be used to communicate between windows:
* ```typescript
* import { appWindow } from '@tauri-apps/api/window';
* await appWindow.listen('sync-data', (event) => { });
*
* // on another window...
* import { WebviewWindow } from '@tauri-apps/api/window';
* const otherWindow = WebviewWindow.getByLabel('other')
* await otherWindow.emit('sync-data');
* ```
*
* Global listeners are also triggered:
* ```typescript
* import { appWindow } from '@tauri-apps/api/window';
* import { listen } from '@tauri-apps/api/event';
* await listen('ping', (event) => { });
*
* await appWindow.emit('ping');
* ```
*
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
* @param payload Event payload.
*/