Adds useful debug features to your Electron app
JavaScript HTML
Latest commit 74e90e8 Nov 5, 2016 @sindresorhus 1.1.0

readme.md

electron-debug

Adds useful debug features to your Electron app

Ideas for more debug features welcome!

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

Activates Devtron

Devtron is the official Electron DevTools extension.

Just install it in your app and we'll activate it for you.

$ npm install --save-dev devtron

Install

$ npm install --save electron-debug

Usage

const {app, BrowserWindow} = require('electron');

require('electron-debug')({showDevTools: true});

let win;

app.on('ready', () => {
    win = new BrowserWindow();
});

API

Only runs when in development, unless overridden by the enabled option. So no need to guard it for production.

electronDebug([options])

Install keyboard shortcuts and optionally activate DevTools on each created BrowserWindow.

options

enabled

Type: boolean

showDevTools

Type: boolean string
Default: false
Values: 'right' 'bottom' 'undocked' false true (last dock state)

Show DevTools on each created BrowserWindow.

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], [showDevTools])

Open DevTools for the specified BrowserWindow instance or the focused one.

window

Type: BrowserWindow
Default: the focused BrowserWindow

showDevTools

Type: boolean string
Default: false
Values: 'right' 'bottom' 'undocked' false true (last dock state)

Show DevTools on each created BrowserWindow.

Related

License

MIT © Sindre Sorhus