ngx-electron is a small Module for Angular which makes calling Electron APIs from the
Renderer Process easier. By adding it to your Angular project, you'll get IntelliSense and a simple Angular service which acts as facade for Electron APIs.
ngx-electron is licensed under MIT.
Checkout the introduction post on my blog for more details.
ngx-electron can be installed easily using either
npm commands in the scope of an angular project.
yarn add ngx-electron --save# ornpm install ngx-electron --save
NgxElectronModule needs to be import in your
root Angular module (eg
Once the module has been imported, you can easily use dependency injection to get an instance of
ElectronService is exposing all API's accessible from within Electron's renderer process. If your app is not running inside electron, all getters will return NULL instead.
desktopCapturer: Electron.DesktopCapturer- Electron's desktop capturing API
ipcRenderer: Electron.IpcRenderer- Electron IpcRenderer
remote: Electron.Remote- Electron Remote capabilities
webFrame: Electron.WebFrame- Electron WebFrame
clipboard: Electron.Clipboard- Clipboard API
crashReporter: Electron.CrashReporter- Electron's CrashReporter
process: NodeJS.Process- Electron's Process Object
screen: Electron.Screen- Electron's Screen API
shell: Electron.Shell- Electron's Shell API
nativeImage: Electron.NativeImage- Electron's NativeImage API
isElectronApp: boolean- Indicates if app is being executed inside of electron or not
isMacOS: boolean- Indicates if app is running in electron and on
isWindows: boolean- Indicates if app is running in electron and on
isLinux: boolean- Indicates if app is running in electron and on
isX86: boolean- Indicates if app is running in electron and on a
isX64: boolean- Indicates if app is running in electron and on a
isArm: boolean- Indiciates it app is running in electron adn on a