Electron Documentation8.2.1
See all of the docs on one page or check out the FAQ.
Guides: Getting Started with Electron
Guides and Tutorials
- Setting up the Development Environment
- Creating your First App
- Boilerplates and CLIs
- Application Architecture
- 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
- Supporting macOS Dark Mode
- Web embeds in Electron
- Accessibility
- Testing and Debugging
- Distribution
- Security
- Updates
- Getting Support
In Detail
Detailed Tutorials
These individual tutorials expand on topics discussed in the guide above.
- Installing Electron
- Electron Releases & Developer Feedback
- Packaging App Source Code with asar
- Testing Widevine CDM
- Using Pepper Flash Plugin
API Reference
Custom DOM Elements
Main Process Modules
Renderer Process Modules
Modules for Both Process Types
API Structures
- BluetoothDevice Object
- Certificate Object
- CertificatePrincipal Object
- Cookie Object
- CPUUsage Object
- CrashReport Object
- CustomScheme Object
- DesktopCapturerSource Object
- Display Object
- Event Object extends GlobalEvent
- ExtensionInfo Object
- FileFilter Object
- FilePathWithHeaders Object
- GPUFeatureStatus Object
- InputEvent Object
- IOCounters Object
- IpcMainEvent Object extends Event
- IpcMainInvokeEvent Object extends Event
- IpcRendererEvent Object extends Event
- JumpListCategory Object
- JumpListItem Object
- KeyboardEvent Object extends Event
- KeyboardInputEvent Object extends InputEvent
- MemoryInfo Object
- MemoryUsageDetails Object
- MimeTypedBuffer Object
- MouseInputEvent Object extends InputEvent
- MouseWheelInputEvent Object extends MouseInputEvent
- NotificationAction Object
- Point Object
- PrinterInfo Object
- ProcessMemoryInfo Object
- ProcessMetric Object
- Product Object
- ProtocolRequest Object
- ProtocolResponse Object
- ProtocolResponseUploadData Object
- Rectangle Object
- Referrer Object
- RemoveClientCertificate Object
- RemovePassword Object
- ScrubberItem Object
- SegmentedControlSegment Object
- SharedWorkerInfo Object
- ShortcutDetails Object
- Size Object
- StreamProtocolResponse Object
- StringProtocolResponse Object
- Task Object
- ThumbarButton Object
- TraceCategoriesAndOptions Object
- TraceConfig Object
- Transaction Object
- UploadBlob Object
- UploadData Object
- UploadFile Object
- UploadRawData Object
- WebSource Object
Advanced
- 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
- Technical Differences Between Electron and NW.js
- Goma
- Issues In Electron
- Patches in Electron
- Pull Requests
- Developing Electron
- Setting Up Symbol Server in Debugger
- Source Code Directory Structure
- Testing
- Upgrading Node
- V8 Development
