events
Functions
emitRemoveWidgetsToCanvas()
emitRemoveWidgetsToCanvas(
payload):Promise<void>
Defined in: events.ts:42
Emit the "remove-widgets" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | RemoveWidgetsPayload | The payload of the event. |
Returns
Promise<void>
emitRenderWidgetToCanvas()
emitRenderWidgetToCanvas(
payload):Promise<void>
Defined in: events.ts:21
Emit the "render-widget" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | RenderWidgetPayload | The payload of the event. |
Returns
Promise<void>
emitSwitchAppearanceToCanvas()
emitSwitchAppearanceToCanvas(
payload):Promise<void>
Defined in: events.ts:86
Emit the "switch-theme-appearance" event to the canvas window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | Appearance | The payload of the event. |
Returns
Promise<void>
emitUpdateSettingsToManager()
emitUpdateSettingsToManager(
payload):Promise<void>
Defined in: events.ts:63
Emit the "update-settings" event to the manager window.
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | UpdateSettingsPayload | The payload of the event. |
Returns
Promise<void>
listenToExitApp()
listenToExitApp(
handler):Promise<UnlistenFn>
Defined in: events.ts:106
Listen to the "exit-app" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<null> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
listenToRemoveWidgets()
listenToRemoveWidgets(
handler):Promise<UnlistenFn>
Defined in: events.ts:52
Listen to the "remove-widgets" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<RemoveWidgetsPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
listenToRenderWidget()
listenToRenderWidget(
handler):Promise<UnlistenFn>
Defined in: events.ts:31
Listen to the "render-widget" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<RenderWidgetPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
listenToShowToast()
listenToShowToast(
handler):Promise<UnlistenFn>
Defined in: events.ts:116
Listen to the "show-toast" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<ShowToastPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
listenToSwitchAppearance()
listenToSwitchAppearance(
handler):Promise<UnlistenFn>
Defined in: events.ts:96
Listen to the "switch-theme-appearance" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<Appearance> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.
listenToUpdateSettings()
listenToUpdateSettings(
handler):Promise<UnlistenFn>
Defined in: events.ts:75
Listen to the "update-settings" event.
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | EventCallback<UpdateSettingsPayload> | The callback function to handle the event. |
Returns
Promise<UnlistenFn>
A promise that resolves to a function to unlisten to the event.