WindowProviderContextValue
Defined in: renderer/context.ts:40
Context for the root WindowProvider
Properties
Section titled “Properties”destroyWindow()
Section titled “destroyWindow()”destroyWindow: (
id) =>Promise<void>
Defined in: renderer/context.ts:59
Destroy a window
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
getWindowState()
Section titled “getWindowState()”getWindowState: (
id) =>Promise<WindowState|null>
Defined in: renderer/context.ts:65
Get window state
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<WindowState | null>
hasBridge
Section titled “hasBridge”hasBridge:
boolean
Defined in: renderer/context.ts:47
Whether the preload bridge is present (globalThis.electron_window exists). When false, all IPC calls no-op and return their fallbacks. Callers can check this to avoid emitting misleading “rejected by main” warnings — the provider already warned about the missing preload.
registerWindow()
Section titled “registerWindow()”registerWindow: (
id,props) =>Promise<boolean>
Defined in: renderer/context.ts:50
Pre-register props with main process before calling window.open
Parameters
Section titled “Parameters”string
Record<string, unknown>
Returns
Section titled “Returns”Promise<boolean>
subscribeToEvents()
Section titled “subscribeToEvents()”subscribeToEvents: (
id,callback) => () =>void
Defined in: renderer/context.ts:68
Subscribe to window events
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(event) => void
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
unregisterWindow()
Section titled “unregisterWindow()”unregisterWindow: (
id) =>Promise<void>
Defined in: renderer/context.ts:53
Unregister a window and clean up resources
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
updateWindow()
Section titled “updateWindow()”updateWindow: (
id,props) =>Promise<void>
Defined in: renderer/context.ts:56
Update window props (for changeable props after creation)
Parameters
Section titled “Parameters”string
Record<string, unknown>
Returns
Section titled “Returns”Promise<void>
windowAction()
Section titled “windowAction()”windowAction: (
id,action) =>Promise<void>
Defined in: renderer/context.ts:62
Perform window action
Parameters
Section titled “Parameters”string
action
Section titled “action”string
Returns
Section titled “Returns”Promise<void>