Electron Documentation

Guides

• About Electron
• Accessibility
• 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
• 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)
• Updating Applications
• Using Native Node Modules
• Using Pepper Flash Plugin
• Using Selenium and WebDriver
• Using Widevine CDM Plugin
• Windows Store Guide
• Windows Taskbar

API Reference

• Accelerator
• app
• autoUpdater
• 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
• 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
• <webview> Tag
• window.open Function

Advanced

• Technical Differences Between Electron and NW.js (formerly node-webkit)
• Build Instructions (experimental GN build)
• 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