Adds useful debug features to your Electron app
Toggle DevTools.
Force reload the window.
Open DevTools and focus the Element Inspector tool.
npm install electron-debug
Requires Electron 30 or later.
import {app, BrowserWindow} from 'electron';
import debug from 'electron-debug';
debug();
let mainWindow;
(async () => {
await app.whenReady();
mainWindow = new BrowserWindow();
})();
Only runs when in development, unless overridden by the isEnabled
option. So no need to guard it for production.
Install keyboard shortcuts and optionally activate DevTools on each created BrowserWindow
.
Type: object
Type: boolean
Type: boolean
\
Default: true
Show DevTools on each created BrowserWindow
.
Type: string
\
Default: 'previous'
\
Values: 'undocked'
'right'
'bottom'
'previous'
'detach'
The dock state to open DevTools in.
Type: (window: BrowserWindow) => boolean | Partial<Options>
\
Default: () => true
(Use the global options for every window)
Specify customized options for each window.
The given function receives the window to apply the filter or new options to.
It must return one of these values:
true
: To enable debug with the global options for the given window.false
: Disable debug for the given window (same as returning {isEnabled: false}
).Partial<Options>
: Object to override global options just for the given window. It does a shallow merge.Toggle DevTools for the specified BrowserWindow
instance or the focused one.
Type: BrowserWindow
\
Default: The focused BrowserWindow
Reload the specified BrowserWindow
instance or the focused one.
Type: BrowserWindow
\
Default: The focused BrowserWindow
Open DevTools for the specified BrowserWindow
instance or the focused one.
Type: BrowserWindow
\
Default: The focused BrowserWindow