Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/electron-debug
Adds useful debug features to your Electron app
https://github.com/sindresorhus/electron-debug
Last synced: about 11 hours ago
JSON representation
Adds useful debug features to your Electron app
- Host: GitHub
- URL: https://github.com/sindresorhus/electron-debug
- Owner: sindresorhus
- License: mit
- Created: 2015-06-01T02:36:20.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-14T06:23:11.000Z (3 months ago)
- Last Synced: 2024-10-29T15:46:30.181Z (3 months ago)
- Language: JavaScript
- Size: 73.2 KB
- Stars: 750
- Watchers: 15
- Forks: 49
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-electron - electron-debug - Adds useful debug features. (Tools / For Electron)
- awesome-electron - electron-debug - Adds useful debug features.  (Library / Debug)
- awesome-electron-zh - electron-debug - Adds useful debug features. (Tools / For Electron)
README
# electron-debug
> Adds useful debug features to your [Electron](https://electronjs.org) app
## Features
### DevTools
Toggle DevTools.
- macOS: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
### Reload
Force reload the window.
- macOS: Cmd R or F5
- Linux: Ctrl R or F5
- Windows: Ctrl R or F5
### Element Inspector
Open DevTools and focus the Element Inspector tool.
- macOS: Cmd Shift C
- Linux: Ctrl Shift C
- Windows: Ctrl Shift C
## Install
```sh
npm install electron-debug
```
*Requires Electron 30 or later.*
## Usage
```js
import {app, BrowserWindow} from 'electron';
import debug from 'electron-debug';
debug();
let mainWindow;
(async () => {
await app.whenReady();
mainWindow = new BrowserWindow();
})();
```
## API
Only runs when in [development](https://github.com/sindresorhus/electron-is-dev), unless overridden by the `isEnabled` option. So no need to guard it for production.
### electronDebug(options?)
Install keyboard shortcuts and optionally activate DevTools on each created `BrowserWindow`.
#### options
Type: `object`
##### isEnabled
Type: `boolean`
##### showDevTools
Type: `boolean`\
Default: `true`
Show DevTools on each created `BrowserWindow`.
##### devToolsMode
Type: `string`\
Default: `'previous'`\
Values: `'undocked'` `'right'` `'bottom'` `'previous'` `'detach'`
The dock state to open DevTools in.
##### windowSelector
Type: `(window: BrowserWindow) => boolean | Partial`\
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`: Object to override global options just for the given window. It does a shallow merge.
### devTools(window?)
Toggle DevTools for the specified `BrowserWindow` instance or the focused one.
#### window
Type: `BrowserWindow`\
Default: The focused `BrowserWindow`
### refresh(window?)
Reload the specified `BrowserWindow` instance or the focused one.
#### window
Type: `BrowserWindow`\
Default: The focused `BrowserWindow`
### openDevTools([window])
Open DevTools for the specified `BrowserWindow` instance or the focused one.
#### window
Type: `BrowserWindow`\
Default: The focused `BrowserWindow`
## Related
- [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps and modules
- [electron-store](https://github.com/sindresorhus/electron-store) - Save and load data like user settings, app state, cache, etc
- [electron-context-menu](https://github.com/sindresorhus/electron-context-menu) - Context menu for your Electron app
- [electron-dl](https://github.com/sindresorhus/electron-dl) - Simplified file downloads for your Electron app
- [electron-unhandled](https://github.com/sindresorhus/electron-unhandled) - Catch unhandled errors and promise rejections in your Electron app
- [electron-reloader](https://github.com/sindresorhus/electron-reloader) - Simple auto-reloading for Electron apps during development
- [electron-serve](https://github.com/sindresorhus/electron-serve) - Static file serving for Electron apps