Interface ElectronApi

The complete surface exposed to the renderer as window.electronApi via contextBridge. The renderer must access Electron-only functionality through this object — direct require("electron") and @electron/remote are unavailable because nodeIntegration is disabled and contextIsolation is enabled.

The runtime value lives in apps/desktop/src/preload.ts; this interface is the contract both the preload script (satisfies ElectronApi) and the client (window.electronApi) share.

interface ElectronApi {
    clipboard: ElectronClipboardApi;
    contextMenu: ElectronContextMenuApi;
    nativeExport: ElectronNativeExportApi;
    nativeImport: ElectronNativeImportApi;
    navigation: ElectronNavigationApi;
    onenote: ElectronOneNoteApi;
    printing: ElectronPrintingApi;
    security: ElectronSecurityApi;
    shell: ElectronShellApi;
    spellcheck: ElectronSpellcheckApi;
    systemIntegration: ElectronSystemIntegrationApi;
    window: ElectronWindowApi;
    ws: ElectronWsApi;
}

Index

Properties

clipboard contextMenu nativeExport nativeImport navigation onenote printing security shell spellcheck systemIntegration window ws

Properties

clipboard

clipboard: ElectronClipboardApi

System clipboard access beyond what the standard Web Clipboard API offers.

contextMenu

contextMenu: ElectronContextMenuApi

Native context-menu plumbing for right-click events on web contents.

nativeExport

nativeExport: ElectronNativeExportApi

Desktop-native subtree export that streams a .zip straight to a file.

nativeImport

nativeImport: ElectronNativeImportApi

Desktop-native large-.zip import that reads the user's file in place via a capability token.

navigation: ElectronNavigationApi

Read/write access to Chromium's back/forward navigation history.

onenote

onenote: ElectronOneNoteApi

OneNote importer sign-in via a loopback OAuth redirect (desktop only).

printing

printing: ElectronPrintingApi

Printing and PDF export pipeline.

security

security: ElectronSecurityApi

Security settings (backend scripting, SQL console) stored outside the DB.

shell

shell: ElectronShellApi

Shell integration — opening URLs, files, and downloads with OS handlers.

spellcheck

spellcheck: ElectronSpellcheckApi

Chromium spell checker controls (dictionary, language list).

systemIntegration

systemIntegration: ElectronSystemIntegrationApi

OS integration — system tray and autostart / launch-on-login.

window

window: ElectronWindowApi

Window chrome, zoom, theme, lifecycle, and main → renderer events.

ws

ws: ElectronWsApi

In-process bridge that replaces the renderer↔server WebSocket.