mirror of
https://github.com/electron/electron.git
synced 2026-05-02 03:00:22 -04:00
8165fd0571
Address review feedback on the desktopCapturer deprecation docs:
- Fix broken anchor link in the deprecation banner (was pointing at
#sessetdisplaymediarequesthandleropts, now correctly points at
#sessetdisplaymediarequesthandlerhandler-opts).
- Rewrite the "After (recommended)" migration example to gate
useSystemPicker on desktopCapturer.isDisplayMediaSystemPickerAvailable()
so the snippet works on Windows, Linux, and macOS < 15 (the previous
version called callback({}) unconditionally and rejected
getDisplayMedia on every non-macOS-15 platform).
- Document desktopCapturer.isDisplayMediaSystemPickerAvailable(), which
has been a runtime export since #43581 but was never added to the
reference docs.
- Update the top-level quickstart comment and prose to match what the
example actually does (tab self-capture, not "first screen found").
- Mirror the platform-aware pattern in session.md.
- Fill in the real PR URL (#51235) in the getSources deprecated YAML
block, drop the unused navigator.mediaDevices.getUserMedia link
definition, and normalize migration-guide list markers to asterisks
so lint:docs passes after the anchor fix exposes the pre-existing
lint failures.
Notes: none
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
- Offscreen Rendering
- Dark Mode
- Web embeds in Electron
- 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
- 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)