mirror of
https://github.com/electron/electron.git
synced 2026-01-11 00:18:02 -05:00
3e5486323a
* docs: `newGuest` in `WebContents` and `webContents` in `BrowsweWindow` According to the example codes in the documentation of `new-window` event in `WebContents`, `webContents` in `BrowsweWindow` constructor options and `newGuest` in `event` argument of `new-window` handler are both existing but documented. This patch is for adding the related documentations. Also, it provides typescript-definitations for these two properties. * Remove the documnent of `webContents` in BrowserWindow constructor option.
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
- 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
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 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
- net
- netLog
- Notification
- powerMonitor
- powerSaveBlocker
- protocol
- screen
- session
- systemPreferences
- TouchBar
- Tray
- webContents