electron/docs

Official Guides

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.

FAQ

There are questions that are asked quite often. Check this out before creating an issue:

• Electron FAQ

Guides and Tutorials

Quickstart

• Quick Start Guide
  • Prerequisites
  • Create a basic application
  • Run your application
  • Package and distribute the application

Learning the basics

• Electron's Process Model
  • Main and Renderer Processes
  • Electron API
  • Node.js API
• Adding Features to Your App
  • Notifications
  • Recent Documents
  • Application Progress
  • Custom Dock Menu
  • Custom Windows Taskbar
  • Custom Linux Desktop Actions
  • Keyboard Shortcuts
  • Offline/Online Detection
  • Represented File for macOS BrowserWindows
  • Native File Drag & Drop
  • Offscreen Rendering
  • Dark Mode
  • Web embeds in Electron
• Boilerplates and CLIs
  • Boilerplate vs CLI
  • electron-forge
  • electron-builder
  • electron-react-boilerplate
  • Other Tools and Boilerplates

Advanced steps

• Application Architecture
  • Using Native Node.js Modules
  • Performance Strategies
  • Security Strategies
• Accessibility
  • Manually Enabling Accessibility Features
• Testing and Debugging
  • Debugging the Main Process
  • Debugging with Visual Studio Code
  • Using Selenium and WebDriver
  • Testing on Headless CI Systems (Travis, Jenkins)
  • DevTools Extension
  • Automated Testing with a Custom Driver
• Distribution
  • Supported Platforms
  • Code Signing
  • Mac App Store
  • Windows Store
  • Snapcraft
• Updates
  • Deploying an Update Server
  • Implementing Updates in Your App
  • Applying Updates
• Getting Support

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.

• Installing Electron
  • Proxies
  • Custom Mirrors and Caches
  • Troubleshooting
• Electron Releases & Developer Feedback
  • Versioning Policy
  • Release Timelines
• Packaging App Source Code with asar
  • Generating asar Archives
  • Using asar Archives
  • Limitations
  • Adding Unpacked Files to asar Archives
• Testing Widevine CDM

---

• Glossary of Terms

API References

• Synopsis
• Process Object
• Supported Command Line Switches
• Environment Variables
• Chrome Extensions Support
• Breaking API Changes

Custom DOM Elements:

• File Object
• <webview> Tag
• window.open Function
• BrowserWindowProxy Object

Modules for the Main Process:

• app
• autoUpdater
• BrowserView
• BrowserWindow
• contentTracing
• dialog
• globalShortcut
• inAppPurchase
• ipcMain
• Menu
• MenuItem
• net
• netLog
• nativeTheme
• Notification
• powerMonitor
• powerSaveBlocker
• protocol
• screen
• session
• systemPreferences
• TouchBar
• Tray
• webContents
• webFrameMain

Modules for the Renderer Process (Web Page):

• contextBridge
• desktopCapturer
• ipcRenderer
• remote
• webFrame

Modules for Both Processes:

• clipboard
• crashReporter
• nativeImage
• shell

Development

See development/README.md