event
Enumerations
ZtronEvent
Defined in: event.ts:23
Upstream event-name constants (ZtronEvent parity). WINDOW_CREATED / WEBVIEW_CREATED fire as app-wide broadcasts on window creation; SUSPENDED/RESUMED are mobile-lifecycle events (desktop hosts do not fire them - names carried for platform parity).
Enumeration Members
DRAG_DROP
DRAG_DROP:
"ztron://drag-drop"
Defined in: event.ts:38
DRAG_ENTER
DRAG_ENTER:
"ztron://drag-enter"
Defined in: event.ts:36
DRAG_LEAVE
DRAG_LEAVE:
"ztron://drag-leave"
Defined in: event.ts:39
DRAG_OVER
DRAG_OVER:
"ztron://drag-over"
Defined in: event.ts:37
WEBVIEW_CREATED
WEBVIEW_CREATED:
"ztron://webview-created"
Defined in: event.ts:35
WINDOW_BLUR
WINDOW_BLUR:
"ztron://blur"
Defined in: event.ts:29
WINDOW_CLOSE_REQUESTED
WINDOW_CLOSE_REQUESTED:
"ztron://close-requested"
Defined in: event.ts:26
WINDOW_CREATED
WINDOW_CREATED:
"ztron://window-created"
Defined in: event.ts:32
WINDOW_DESTROYED
WINDOW_DESTROYED:
"ztron://destroyed"
Defined in: event.ts:27
WINDOW_FOCUS
WINDOW_FOCUS:
"ztron://focus"
Defined in: event.ts:28
WINDOW_MOVED
WINDOW_MOVED:
"ztron://move"
Defined in: event.ts:25
WINDOW_RESIZED
WINDOW_RESIZED:
"ztron://resize"
Defined in: event.ts:24
WINDOW_RESUMED
WINDOW_RESUMED:
"ztron://resumed"
Defined in: event.ts:34
WINDOW_SCALE_FACTOR_CHANGED
WINDOW_SCALE_FACTOR_CHANGED:
"ztron://scale-change"
Defined in: event.ts:30
WINDOW_SUSPENDED
WINDOW_SUSPENDED:
"ztron://suspended"
Defined in: event.ts:33
WINDOW_THEME_CHANGED
WINDOW_THEME_CHANGED:
"ztron://theme-changed"
Defined in: event.ts:31
Interfaces
Event
Defined in: event.ts:42
Type Parameters
T
T
Properties
event
event:
string
Defined in: event.ts:44
Event name.
id
id:
number
Defined in: event.ts:46
Event identifier used to unlisten.
payload
payload:
T
Defined in: event.ts:48
Event payload.
Options
Defined in: event.ts:55
Properties
target?
optionaltarget?:string|EventTarget
Defined in: event.ts:57
The event target to listen to, defaults to { kind: 'Any' }.
Type Aliases
EventCallback
EventCallback<
T> = (event) =>void
Defined in: event.ts:51
Type Parameters
T
T
Parameters
event
Event<T>
Returns
void
EventTarget
EventTarget = {
kind:"Any"; } | {kind:"AnyLabel";label:string; } | {kind:"App"; } | {kind:"Window";label:string; } | {kind:"Webview";label:string; } | {kind:"WebviewWindow";label:string; }
Defined in: event.ts:9
Tauri-compatible event target.
UnlistenFn
UnlistenFn = () =>
Promise<void>
Defined in: event.ts:53
Returns
Promise<void>
Functions
emit()
emit<
T>(event,payload?):Promise<void>
Defined in: event.ts:106
Emits an event to the backend (which fans it out to listeners).
Type Parameters
T
T
Parameters
event
string
payload?
T
Returns
Promise<void>
emitTo()
emitTo<
T>(target,event,payload?):Promise<void>
Defined in: event.ts:111
Emits an event to listeners matching the given target.
Type Parameters
T
T
Parameters
target
string | EventTarget
event
string
payload?
T
Returns
Promise<void>
listen()
listen<
T>(event,handler,options?):Promise<UnlistenFn>
Defined in: event.ts:73
Listens to an event.
Type Parameters
T
T
Parameters
event
string
handler
options?
Returns
Promise<UnlistenFn>
A promise resolving to an unlisten function (call it when the listener goes out of scope).
once()
once<
T>(event,handler,options?):Promise<UnlistenFn>
Defined in: event.ts:89
Listens to an event once; unlistens automatically after the first fire.
Type Parameters
T
T
Parameters
event
string
handler
options?
Returns
Promise<UnlistenFn>