Version 2.6.7 of debug just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As debug is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

👋 Hi, just wanted to share a rewrite I did that added webview support, in case you wanted to copy from any of it. It was easiest for me to do a rewrite that dropped features I didn't need, so unfortunately it's not a simple PR.

https://github.com/beakerbrowser/electron-localshortcut

It checks accelerator, and then calls _unregisterShortcut on accelerator.accelerator

There is what seems to be a debug log statement here

Is it possible to listen for shortcut only on window, and not for example when user clicks into form inside the main window

I have a transparent window.

When i use your library and register a shortcut and then press the keys, it converts the window to not being transparent.

When I use globalShortcut, it doesn't change the window transparency setting.

localShortcut.register(mainWindow,'PrintScreen',()=>{
//stuff
})
Code is not working.Electron cant detect 'PrintScreen' keypress

Version 1.2.0 of p-event just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As p-event is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Hi,
I'm trying to remove all shortcuts on app.ready.
I'm using electron V5.07 and localshortcut V3.1.0

My code main.js:

const { app, BrowserWindow, ipcMain, webContents, session, dialog, globalShortcut } = require('electron');
const localshortcut = require('electron-localshortcut');
const settings = require('electron-settings');
const menu = require('./menu');
const fs = require('fs-extra');

let win, mainWindow, newWindow, sets;

app.on('ready', function() {
    // defines mainWindow
    createMainWindow();

    // and load the index.html of the app.
    mainWindow.loadFile('index.html');

    mainWindow.once('ready-to-show', () => {
        mainWindow.show()
    });

    mainWindow.on('leave-full-screen', () => {
        mainWindow.setAutoHideMenuBar(false);
        mainWindow.setMenuBarVisibility(true);
    });

    mainWindow.on('enter-full-screen', () => {
        mainWindow.setAutoHideMenuBar(true);
        mainWindow.setMenuBarVisibility(false);
    });

    localshortcut.unregisterAll(mainWindow);
});

...

function createMainWindow () {
    // Create the browser window.
    mainWindow = new BrowserWindow({
        width: 1000,
        height: 600,
        closable: false,
        resizable: false,
        autoHideMenuBar: true,
        fullscreenable: true,
        // fullscreen: true,    // @TODO - on production set to true and active
        minimizable: false,
        webPreferences: {
            nodeIntegration: true,
            devTools: true,     // @TODO - on production set to false
            plugins: true,
            webviewTag: true,
            webgl: true,
            webaudio: true
        }
    });

    const menu = require('./menu');

    mainWindow.on('closed', () => {
        mainWindow = null;
    })
}
...

The error I get:

What am I doing wrong?
line 42 is: localshortcut.unregisterAll(mainWindow);

Another question would be - how to disable alt+f4, etc? is it possible? All my tries don't work.

If I define register for Ctrl + Z or Ctrl + Y for undo and redo, only the one defined first is executed, regardless of whether Ctrl + Z or Ctrl + Y is typed on keyboard. I use a qwertz keyboard for input.

  electronLocalshortcut.register(win, 'Ctrl+Z', () => {
    ... [executed if Ctrl + Z or Ctrl + Y is pressed]
  });
  electronLocalshortcut.register(win, 'Ctrl+Y', () => {
    ... [never executed]
  });

electron 6.X
electron-localshortcut 3.x

This isRegistered interface always returns undefined

I searching for a solution for get clicks when the main window do not is focus.

The devDependency delay was updated from 4.0.1 to 4.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

delay is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

I try to implement opening of the DevTools on F12 press.
My code (main.js):

const electronLocalshortcut = require('electron-localshortcut');
electronLocalshortcut.register('F12', function() {
    console.log("F12 pressed!")
});

Nothing happened.
Other shortcuts that I tried instead of F12 do work (F11, F3, Ctrl+A and etc.)

Investigate if exists an engine reuiqrement specific for electron

In case of an another window exit full screen, the window of registered shortcuts is not focused but show event will be emitted, it's bug because it hijacked shortcuts of an another window.

The project uses [email protected] which includes [email protected]
When I start the application, I get an error when I press any key on the keyboard.

When I used the previous version ([email protected] + [email protected]) of this problem was not observed

my code:

electronLocalshortcut.register(win, 'Ctrl+Space', () => {
// stuff
});

I'm trying out the Brave browser and I noticed that it doesn't currently register its keyboard shortcuts correctly. I assume they're busy with all sorts of other things and don't have time to help a picky Dvorak user such as me, so I figured I'd help them out. I'm new to electron but familiar with JS & React & webpack, etc.

The issue

I use the Dvorak keyboard layout. When I press cmdshift] to try to switch tabs, Brave-via-electronlocalshortcut looks at the key position rather than the character typed, and instead sends cmdshift+. I zoom in instead of switching tabs.

The code

Here's how they define their shortcuts. Essentially:

const electronLocalshortcut = require('electron-localshortcut')

module.exports.register = win => {
  electronLocalshortcut.register(win, 'CmdOrCtrl+Shift+]', () => {...})
}

What's wrong?

Is there something that they did wrong, or is this an error in electron-localshortcut? Point me in the right direction and I can help fix the issue.

Thanks!

I'm using this as a reference: https://electronjs.org/docs/api/accelerator

All of the below hotkeys should work in theory and I have confirmed that esc and numadd function as intended when registering directly with electron

Errors listed below. Thank you very, very much for this awesome library. It patches a weakness in Electron and makes development a lot more pleasant.

WARNING: esc is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)


WARNING: numadd is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

17:27:43.999 > Error: Unvalid keycode `u`.
    at reduceKey (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:186:9)
    at toKeyEvent (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:274:14)
    at Object.register (webpack:///./node_modules/electron-localshortcut/index.js?:224:21)
    at eval (webpack:///./app/desktop/main/secondaryWindow.js?:150:29)
    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

WARNING: shift+- is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)


WARNING: shift+numadd is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

17:27:44.023 > Error: Unvalid keycode `u`.
    at reduceKey (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:186:9)
    at toKeyEvent (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:274:14)
    at Object.register (webpack:///./node_modules/electron-localshortcut/index.js?:224:21)
    at eval (webpack:///./app/desktop/main/secondaryWindow.js?:150:29)
    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

WARNING: ctrl+- is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)


WARNING: ctrl+numadd is not a valid accelerator.

    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

17:27:44.032 > Error: Unvalid keycode `u`.
    at reduceKey (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:186:9)
    at toKeyEvent (webpack:///./node_modules/keyboardevent-from-electron-accelerator/index.js?:274:14)
    at Object.register (webpack:///./node_modules/electron-localshortcut/index.js?:224:21)
    at eval (webpack:///./app/desktop/main/secondaryWindow.js?:150:29)
    at Array.forEach (<anonymous>)
    at createSecondaryMenu (webpack:///./app/desktop/main/secondaryWindow.js?:148:76)
    at createMainWindow (webpack:///./app/desktop/main/createMainWindow.js?:89:74)

Using this for the first time. The code below does not work on a mac:

electronLocalshortcut.register( 'CmdOrCtrl+`', () => {
    console.log(12123123);
});

I suspect the issue is somewhere around here:

# index.js -> L129 ...

	const event = _normalizeEvent(input);

	debug(`before-input-event: ${input} is translated to: ${event}`);
	for (const {eventStamp, callback} of shortcutsOfWindow) {
		console.log(equals(eventStamp, event), eventStamp, event);
		**if (equals(eventStamp, event)) {**
			debug(`eventStamp: ${eventStamp} match`);
			callback();

			return;
		}

Console output:

false { metaKey: true, key: '`', code: 'Backquote' } {
  code: 'MetaLeft',
  key: 'Meta',
  altKey: false,
  shiftKey: false,
  metaKey: true,
  ctrlKey: false
}

Hello,

I was having an issue with the electron application Caprine posted here:
sindresorhus/caprine#202

The issue was that f5 and ctrl+shift+c were not being unregistered when I minimized Caprine to the tray, so I could no longer use f5 to refresh pages in my browser; the key was still bound to Caprine.

If I brought Caprine out of the tray or killed the application, I regained control of the f5 key.

I have been told that the issue is likely with this package not unregistering the shortcuts on a minify event.

Is there something I can do to help confirm/fix this?

Version 1.1.0 of p-timeout just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As p-timeout is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

In the first time of calling register(), the following code line 167-177 register the event for the window

if (win !== ANY_WINDOW) {
    win.on('close', _unregister('the window was closed.'));

    win.on('hide', _unregister('the window was hidden.'));

    win.on('minimize', _unregister('the window was minimized.'));

    win.on('restore', _register('the window was restored from minimized state.'));

    win.on('show', _register('the window was showed.'));
}

However, these registered event are not freed after calling unregisterAll. This will cause memory leakage.

The dependency debug was updated from 4.0.1 to 4.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

debug is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

I'm not able to use the local shortcuts correctly. On closing window the shortcuts are still registered and throws error. I'm using it like this. @parro-it can you suggest me where I'm going wrong?

The devDependency p-event was updated from 2.1.0 to 2.2.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

p-event is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

No real issue, just reporting this oddity

I just setup a new electron-vue project and run into the issue:

Install vue-cli and scaffold boilerplate

npm install -g vue-cli
vue init simulatedgreg/electron-vue my-project

Install dependencies and run your app

cd my-project
npm install
npm run dev

Error

The last command builds the app and the error is produced.

...
┗ ----------------------------

┏ Electron -------------------

  App threw an error during load
  C:\Users\blibla\myvueelectron\node_modules\electron-localshortcut\index.js:20
                } catch {
                        ^

  SyntaxError: Unexpected token {
      at createScript (vm.js:80:10)
      at Object.runInThisContext (vm.js:139:10)
      at Module._compile (module.js:606:28)
      at Object.Module._extensions..js (module.js:653:10)
      at Module.load (module.js:561:32)
      at tryModuleLoad (module.js:504:12)
      at Function.Module._load (module.js:496:3)
      at Module.require (module.js:586:17)
      at require (internal/module.js:11:18)
      at eval (webpack:///external_%22electron-localshortcut%22?:1:18)

┗ ----------------------------

Catch without parameter doesn't seem to be supported by the other tools yet. Not sure if this is your business but wanted to let you know about it.

Workaround

Use 3.1.0

npm install [email protected]
npm run dev

I noticed you are using the before-input-event event to listen for shortcuts. Would it be possible to prevent the default action by reading the result from the callback function?

Exactly in this place and call e.preventDefault() if the result is true.

I want to enable/disable the shortcut based on the status of a UI component, like show or hidden. Is it possible to achieve that on the renderer process?

When I try to require('electron-localshortcut'), I get an error:

Uncaught TypeError: Cannot read property 'on' of undefined

This is because it's grabbing app by a direct require, while it needs to be obtained from remote if in the render process.

Looking at index.js:

• debug
• electron
• electron-is-accelerator

are dependencies, but only electron-is-accelerator is listed under devDependencies.

I'm unregister all shortcuts and register them with new callbacks but they are just available after I tab out and back in the window.
So they get unregistered and also registered but arent' useable.

Do you have any idea why or how to solve it?

const shortcut = require('electron-localshortcut');
shortcut.register('CommandOrControl+E', function () {
    screen_edit();
});
shortcut.unregisterAll();
shortcut.register('CommandOrControl+E', function () {
    win.webContents.send('save-img-cfg');
    screen_show();
});

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

Your Greenkeeper Bot 🌴

Hi,
With an azerty keyboard, the input object can looks like this:

{
  type: 'keyDown',
  key: 'w',
  code: 'KeyZ',
  // ...
}
// or 
{
  type: 'keyDown',
  key: 'z',
  code: 'KeyW',
  // ...
}

The input comparison fails to differentiate these cases. It does not occur with electron global shortcuts.

Can I use electron-localshortcut in renderer.js (which is not main file) ???
And if yes, then how ??
I know about remote api of electron but it doesn't work ?

Thanks in advance .

The devDependency electron was updated from 3.0.0 to 3.0.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

electron is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Hey, if I pack my project with this I get an error on execution:

Uncaught Exception:
Error: Cannot find module 'debug'
https://github.com/parro-it/electron-localshortcut/blob/master/index.js#L4

This module is in the devDependencies but included in the code. So should it be in the dependencies or removed or trapped on load like:

try {
    const _debug = require('debug');
    const debug = _debug('electron-localshortcut');
} catch (ex) {
    const debug = function(arg){};
}

I just installed and configured as instructed and I get this error when I launch electron.

This a new project, started with create-react-app and then adding electron, the standard main.js file from electron-quick-start, and the few necessary changes to package.json. I also added a .env file with BROWSER=none and a different port and I'm using concurrently and wait-on to start react in the electron window.

Could one of these things be interfering?

Version 1.6.8 of electron just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As electron is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

I started to implement a DOM based version of electron-localshortcut, in an effort to make it less error prone and less "aggressive".

Many issues of this module was caused by the fact that it uses globalShortcut method to register shortcuts. These interferes with the other system shortcuts, often in an obstrusive way...

The new version will instead listen for DOM keydown and keyup events, and will trigger shortcut handlers if emitted DOM events match the registered Accelerator.

Today I published keyboardevent-from-electron-accelerator, a module that take an Accelerator and convert it to a derived Keyboard event.

The new version of electron-localshortcut will use it to check if an emitted keyvoard event match a registered shortcuts.

It would be beautiful if anyone interested would check the module on runkit to help catch bugs before use the module as dependency here.

This used to work in v2, but stopped working in v3:

localShortcut.register('Cmd+Alt+I', () => {
  console.log('Works');
});

Other accelerators like `'Cmd+Shift+C'` work.