Electron Documentation5.0.1
See all of the docs on one page or check out the FAQ.
Guides
- 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 Release Timelines
- 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
API Reference
- 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
- Promisification
- 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
API Structures
- BluetoothDevice Object
- Certificate Object
- CertificatePrincipal Object
- Cookie Object
- CPUUsage Object
- CrashReport Object
- CustomScheme 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
- TraceCategoriesAndOptions Object
- TraceConfig Object
- Transaction Object
- UploadBlob Object
- UploadData Object
- UploadFile Object
- UploadRawData Object
- WebSource Object
Advanced
- Technical Differences Between Electron and NW.js (formerly node-webkit)
- Updating an Appveyor Azure Image
- 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
- Setting Up Symbol Server in Debugger
- Source Code Directory Structure
- Testing
- Upgrading Chromium
- Upgrading Crashpad
- Upgrading Node
- V8 Development