https://github.com/akameco/electron-load-devtool

Easily load dev tool for electron
https://github.com/akameco/electron-load-devtool

electron

Last synced: 3 months ago
JSON representation

Easily load dev tool for electron

• Host: GitHub
• URL: https://github.com/akameco/electron-load-devtool
• Owner: akameco
• License: mit
• Created: 2016-08-15T18:12:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-17T10:52:26.000Z (about 6 years ago)
• Last Synced: 2024-11-14T15:49:08.042Z (3 months ago)
• Topics: electron
• Language: JavaScript
• Homepage:
• Size: 143 KB
• Stars: 24
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# electron-load-devtool

[![Build Status](https://travis-ci.org/akameco/electron-load-devtool.svg?branch=master)](https://travis-ci.org/akameco/electron-load-devtool)

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

> Easily Load devtools-extension for electron

## why?

Electron supports the Chrome DevTools Extension.

But, it's a [very bother](https://github.com/electron/electron/blob/master/docs/tutorial/devtools-extension.md).

This module can load simply for your development environment.

And, support some devtool-extensions like redux-devtools by default.

## Install

```

$ npm install --save-dev electron-load-devtool

```

## Usage

```js

const electron = require('electron')

const loadDevtool = require('electron-load-devtool')

electron.app.on('ready', () => {

  const win = new electron.BrowserWindow({ width: 400, height: 400 })

  win.loadURL(`file://${__dirname}/index.html`)

  loadDevtool(loadDevtool.REDUX_DEVTOOLS)

  win.openDevTools()

})

```

## API

### `loadDevtool(devtoolId, [options])`

#### devtoolId

Type: `string`

#### options

##### enabled

Type: `boolean`


Only runs when in development, unless overridden by the enabled option.

So no need to guard it for production.

##### name

Type: `string`


Default: `google-chrome`

If you using chromium on Linux, set `chromium`.

##### profile

Type: `string`


Default: `Default`

Specific Chrome Profile name.

##### version

Type: `string`


Default: `latest`

Specific devtools-extension version.

### `loadDevtool.REDUX_DEVTOOLS`

### `loadDevtool.EMBER_INSPECTOR`

### `loadDevtool.REACT_DEVELOPER_TOOLS`

### `loadDevtool.BACKBONE_DEBUGGER`

### `loadDevtool.JQUERY_DEBUGGER`

### `loadDevtool.ANGULARJS_BATARANG`

### `loadDevtool.VUEJS_DEVTOOLS`

### `loadDevtool.VUEJS_DEVTOOLS_BETA`

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [
akameco](http://akameco.github.io)
[💻](https://github.com/akameco/electron-load-devtool/commits?author=akameco "Code") [📖](https://github.com/akameco/electron-load-devtool/commits?author=akameco "Documentation") [🚇](#infra-akameco "Infrastructure (Hosting, Build-Tools, etc)") | [
mactkg](http://mactkg.hateblo.jp)
[💻](https://github.com/akameco/electron-load-devtool/commits?author=mactkg "Code") | [
Jasper Poppe](https://github.com/jpoppe)
[💻](https://github.com/akameco/electron-load-devtool/commits?author=jpoppe "Code") | [
Yoshiyuki Kinjo](https://github.com/yskkin)
[💻](https://github.com/akameco/electron-load-devtool/commits?author=yskkin "Code") |

| :---: | :---: | :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## License

MIT © [akameco](http://akameco.github.io)