ngx-electron
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.
Introduction
Checkout the introduction post on my blog for more details.
Support me
Installation
ngx-electron
can be installed easily using either yarn
or npm
commands in the scope of an angular project.
yarn add ngx-electron --save# or npm install ngx-electron --save
The NgxElectronModule
needs to be import in your root
Angular module (eg AppModule
).
;;;;
Once the module has been imported, you can easily use dependency injection to get an instance of ElectronService
.
;;
ElectronService
The 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.
Properties
desktopCapturer: Electron.DesktopCapturer
- Electron's desktop capturing APIipcRenderer: Electron.IpcRenderer
- Electron IpcRendererremote: Electron.Remote
- Electron Remote capabilitieswebFrame: Electron.WebFrame
- Electron WebFrameclipboard: Electron.Clipboard
- Clipboard APIcrashReporter: Electron.CrashReporter
- Electron's CrashReporterprocess: NodeJS.Process
- Electron's Process Objectscreen: Electron.Screen
- Electron's Screen APIshell: Electron.Shell
- Electron's Shell APInativeImage: Electron.NativeImage
- Electron's NativeImage APIisElectronApp: boolean
- Indicates if app is being executed inside of electron or notisMacOS: boolean
- Indicates if app is running in electron and onmacOS
isWindows: boolean
- Indicates if app is running in electron and onWindows
isLinux: boolean
- Indicates if app is running in electron and onLinux
isX86: boolean
- Indicates if app is running in electron and on ax86
architectureisX64: boolean
- Indicates if app is running in electron and on ax64
architectureisArm: boolean
- Indiciates it app is running in electron adn on aARM
architecture