mirror of
https://github.com/electron/electron.git
synced 2026-04-10 03:01:51 -04:00
09430e27a9
* Add MDN link to web-request-filter.md When I was using the Electron docs I wanted to know how to use [webRequest.onBeforeSendHeaders](https://www.electronjs.org/docs/latest/api/web-request#webrequestonbeforesendheadersfilter-listener) but I was unable to correctly guess the correct format for the `WebRequestFilter` URL strings, and there was no explanation in the Electron docs. Eventually I googled it and found the MDN article which helped me. Co-authored-by: Hugh Davey <9026053+hughjdavey@users.noreply.github.com> * Update docs/api/structures/web-request-filter.md Co-authored-by: Black-Hole <158blackhole@gmail.com> Co-authored-by: Hugh Davey <9026053+hughjdavey@users.noreply.github.com> * Update docs/api/structures/web-request-filter.md Co-authored-by: Black-Hole <158blackhole@gmail.com> Co-authored-by: Hugh Davey <9026053+hughjdavey@users.noreply.github.com> Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Hugh Davey <9026053+hughjdavey@users.noreply.github.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
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