Electron Documentation

Guides

• About Electron
• Accessibility
• Application Distribution
• Application Packaging
• Debugging the Main Process
• Debugging the Main Process in node-inspector
• Debugging the Main Process in VSCode
• Desktop Environment Integration
• DevTools Extension
• Electron Versioning
• Installation
• Keyboard Shortcuts
• Mac App Store Submission Guide
• Multithreading
• Notifications (Windows, Linux, macOS)
• Offscreen Rendering
• Online/Offline Event Detection
• Planned Breaking API Changes
• Quick Start
• REPL
• Security, Native Capabilities, and Your Responsibility
• Supported Platforms
• Testing on Headless CI Systems (Travis CI, Jenkins)
• Using Native Node Modules
• Using Pepper Flash Plugin
• Using Selenium and WebDriver
• Using Widevine CDM Plugin
• Windows Store Guide

API Reference

Main Process

• Accelerator
• app
• autoUpdater
• BrowserWindow
• Certificate Object
• Supported Chrome Command Line Switches
• ClientRequest
• contentTracing
• Cookies
• Debugger
• dialog
• DownloadItem
• Frameless Window
• globalShortcut
• IncomingMessage
• ipcMain
• JumpListCategory Object
• JumpListItem Object
• Locales
• Menu
• MenuItem
• net
• powerMonitor
• powerSaveBlocker
• protocol
• session
• systemPreferences
• Task Object
• ThumbarButton Object
• TouchBar
• TouchBarButton
• TouchBarColorPicker
• TouchBarGroup
• TouchBarLabel
• TouchBarPopover
• TouchBarScrubber
• TouchBarSegmentedControl
• TouchBarSlider
• TouchBarSpacer
• Tray
• webContents
• WebRequest

Renderer Process

• BrowserWindowProxy
• desktopCapturer
• File Object
• ipcRenderer
• MemoryUsageDetails Object
• remote
• webFrame
• <webview> Tag
• window.open Function

Both Processes

• clipboard
• crashReporter
• Display Object
• Environment Variables
• nativeImage
• process
• Rectangle Object
• screen
• shell
• ShortcutDetails Object
• Synopsis

Advanced

• Technical Differences Between Electron and NW.js (formerly node-webkit)
• 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
• Releasing
• Setting Up Symbol Server in Debugger
• Source Code Directory Structure
• Upgrading Chrome Checklist
• V8 Development