mirror of
https://github.com/electron/electron.git
synced 2026-01-09 15:38:08 -05:00
590858a38d
* docs: fix camelcase in menu example and add hint to deal with TS error hideothers -> hideOthers (the TS compiler caught this) The TypeScript compiler also did not like the pattern used to switch between platforms for submenus was loosing the type information of the literal constants and generalized them as strings which conflicts with the type definition of MenuItemConstructorOptions. * docs: Fix spelling, added hint to TypeScript Without explicitly stating the type for the const template TypeScript does not create a with the correct shape due to generalization to strings. * remove ts hints Co-authored-by: a <a@b> Co-authored-by: Cheng Zhao <github@zcbenz.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
- Boilerplates and CLIs
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
- Testing Widevine CDM
API References
- Synopsis
- Process Object
- Supported Command Line Switches
- Environment Variables
- Chrome Extensions Support
- Breaking API Changes
Custom DOM Elements:
Modules for the Main Process:
- app
- autoUpdater
- BrowserView
- BrowserWindow
- contentTracing
- dialog
- globalShortcut
- inAppPurchase
- ipcMain
- Menu
- MenuItem
- MessageChannelMain
- MessagePortMain
- net
- netLog
- nativeTheme
- Notification
- powerMonitor
- powerSaveBlocker
- protocol
- screen
- session
- ShareMenu
- systemPreferences
- TouchBar
- Tray
- webContents
- webFrameMain