@zturnlibs/ztron-api


event

Enumerations

ZtronEvent

Defined in: event.ts:23

上游事件名常量(ZtronEvent 对齐)。WINDOW_CREATED / WEBVIEW_CREATED 在窗口创建时作为应用级广播触发;SUSPENDED/RESUMED 是移动端生命周期事件(桌面 host 不触发——仅为平台对齐保留名字)。

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

事件名。

id

id: number

Defined in: event.ts:46

用于取消监听的事件标识符。

payload

payload: T

Defined in: event.ts:48

事件载荷。


Options

Defined in: event.ts:55

Properties

target?

optional target?: string | EventTarget

Defined in: event.ts:57

要监听的事件目标,默认 { 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 兼容的事件目标。


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

向后端发出一个事件(由后端分发给所有监听者)。

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

向匹配指定目标的监听者发出事件。

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

监听一个事件。

Type Parameters

T

T

Parameters

event

string

handler

EventCallback<T>

options?

Options

Returns

Promise<UnlistenFn>

一个 Promise,resolve 为取消监听函数(当监听器离开作用域时调用它)。


once()

once<T>(event, handler, options?): Promise<UnlistenFn>

Defined in: event.ts:89

监听一个事件;首次触发后自动取消监听。

Type Parameters

T

T

Parameters

event

string

handler

EventCallback<T>

options?

Options

Returns

Promise<UnlistenFn>