mirror of
https://github.com/electron/electron.git
synced 2026-10-28 11:44:46 +08:00
* docs: note beta.1 waits for the Chromium roll The Releases WG moved alpha-to-beta promotion to release automation, gated on the release branch's Chromium reaching the version in Chrome's Beta channel. beta.1 is no longer a fixed date, so stop listing it as one of our solid release dates and note it can land a few days late. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 * docs: explain beta.1 delay without roll jargon Say plainly that beta.1 can be late when the release branch has not yet been updated to the Chromium Beta-channel version, instead of referring to "our Chromium roll" without explaining it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 * docs: link Chrome's Beta channel in release timeline Link to Chromium's release channel page and briefly explain that the Beta channel is where each Chrome version is tested for about four weeks before stable. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 * docs: clarify which release dates are fixed Replace "our solid release dates" with plain wording: alpha.1 and stable ship on the scheduled dates, while the prereleases in between, including beta.1, don't have fixed dates. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 * docs: tighten beta.1 timing note Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 * docs: use canonical Chrome release channels URL Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AmPhpNhEFuPd7juZ3fc781 --------- Co-authored-by: Claude <noreply@anthropic.com>
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:
Guides and Tutorials
Getting started
Learning the basics
- 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
- Navigation History
- Window State Persistence
- Offscreen Rendering
- Dark Mode
- Web embeds in Electron
Advanced steps
- Application Architecture
- Accessibility
- Testing and Debugging
- Distribution
- Updates
- Getting Support
Detailed Tutorials
These individual tutorials expand on topics discussed in the guide above.
- Installing Electron
- Electron Releases & Developer Feedback
API References
- Process Object
- Supported Command Line Switches
- Environment Variables
- Chrome Extensions Support
- Breaking API Changes
Custom Web Features:
Modules for the Main Process:
- app
- autoUpdater
- BaseWindow
- BrowserWindow
- contentTracing
- desktopCapturer
- dialog
- globalShortcut
- inAppPurchase
- ImageView
- ipcMain
- Menu
- MenuItem
- MessageChannelMain
- MessagePortMain
- nativeTheme
- net
- netLog
- Notification
- powerMonitor
- powerSaveBlocker
- protocol
- pushNotifications
- safeStorage
- screen
- ServiceWorkerMain
- session
- ShareMenu
- systemPreferences
- TouchBar
- Tray
- utilityProcess
- View
- webContents
- webFrameMain
- WebContentsView
Modules for the Renderer Process (Web Page):
Modules for Both Processes:
- clipboard (non-sandboxed renderers only)
- crashReporter
- nativeImage
- shell (non-sandboxed renderers only)