Everyone

NextLabs.cc

Nougat

Electron 3.0 Documentation

Electron (formerly known as Atom Shell) is an open-source framework created and maintained by GitHub. It allows for the development of desktop GUI applications using front and back end components originally developed for web applications: Node.js runtime for the backend and Chromium for the frontend. 

Electron is the main GUI framework behind several notable open-source projects including GitHub's Atom and Microsoft's Visual Studio Code source code editors, the Tidal music streaming service desktop application and the Light Table IDE, in addition to the freeware desktop client for the Discord chat service.

Table of Content

About Electron
Accessibility
Electron App Feedback Program
Electron Application Architecture
Application Debugging
Application Distribution
Application Packaging
Automated Testing with a Custom Driver
Boilerplates and CLIs
Code Signing
Debugging the Main Process
Debugging the Main Process in VSCode
Desktop Environment Integration
Developer Environment
DevTools Extension
Electron Versioning
Writing Your First Electron App
In-App Purchase (macOS)
Installation
Keyboard Shortcuts
Custom Linux Desktop Launcher Actions
Mac App Store Submission Guide
MacOS Dock
Mojave Dark Mode
Multithreading
Native File Drag & Drop
Notifications (Windows, Linux, macOS)
Offscreen Rendering
Online/Offline Event Detection
Progress Bar in Taskbar (Windows, macOS, Unity)
Quick Start
Recent Documents (Windows & macOS)
REPL
Represented File for macOS BrowserWindows
Security, Native Capabilities, and Your Responsibility
Snapcraft Guide (Ubuntu Software Center & More)
Electron Support
Testing on Headless CI Systems (Travis CI, Jenkins)
Testing Widevine CDM
Updating Applications
Using Native Node Modules
Using Pepper Flash Plugin
Using Selenium and WebDriver
Windows Store Guide
Windows Taskbar
Accelerator
app
autoUpdater
API Contract
BrowserView
BrowserWindow
BrowserWindowProxy
Supported Chrome Command Line Switches
ClientRequest
clipboard
contentTracing
Cookies
crashReporter
Debugger
desktopCapturer
dialog
DownloadItem
Environment Variables
File Object
Frameless Window
globalShortcut
inAppPurchase
IncomingMessage
ipcMain
ipcRenderer
Locales
Menu
MenuItem
nativeImage
net
netLog
Notification
powerMonitor
powerSaveBlocker
process
protocol
remote
sandbox Option
screen
session
shell
Synopsis
systemPreferences
TouchBar
TouchBarButton
TouchBarColorPicker
TouchBarGroup
TouchBarLabel
TouchBarPopover
TouchBarScrubber
TouchBarSegmentedControl
TouchBarSlider
TouchBarSpacer
Tray
webContents
webFrame
WebRequest
Tag
window.open Function
BluetoothDevice Object
Certificate Object
CertificatePrincipal Object
Cookie Object
CPUUsage Object
CrashReport Object
DesktopCapturerSource Object
Display Object
FileFilter Object
GPUFeatureStatus Object
IOCounters Object
JumpListCategory Object
JumpListItem Object
MemoryInfo Object
MemoryUsageDetails Object
MimeTypedBuffer Object
NotificationAction Object
Point Object
PrinterInfo Object
ProcessMetric Object
Product Object
Rectangle Object
Referrer Object
RemoveClientCertificate Object
RemovePassword Object
ScrubberItem Object
SegmentedControlSegment Object
ShortcutDetails Object
Size Object
StreamProtocolResponse Object
Task Object
ThumbarButton Object
Transaction Object
UploadBlob Object
UploadData Object
UploadFile Object
UploadRawData Object
WebSource Object
Technical Differences Between Electron and NW.js (formerly node-webkit)
Build Instructions
Build Instructions (Linux)
Build Instructions (macOS)
Build Instructions (Windows)
Build System Overview
Chromium Development
Using clang-format on C++ Code
Coding Style
Debugging on Windows
Debugging on macOS
Debugging with XCode
Issues In Electron
Pull Requests
Developing Electron
Releasing
Setting Up Symbol Server in Debugger
Source Code Directory Structure
Testing
Upgrading Chromium
Upgrading Crashpad
Upgrading Node
V8 Development


Electron 3.0 Docs

Latest Version of Electron 3.0 Docs