Miss any of our Open RFC calls?Watch the recordings here! »

electron-shortcut

0.5.0 • Public • Published

electron-shortcut

Helper for registering global shortcut

Install

$ npm install --save electron-shortcut

Usage

const Shortcut = require('electron-shortcut');
 
// create and register a shortcut with auto-register when windows got focus
var shortcut = new Shortcut('Command+1', handler);
 
// create and register shortcuts with manual-register
var shortcut = new Shortcut(['Command+2', 'Command+3'], {
    autoRegister: false
}, handler);
 
shortcut.register();
 
// with static method
Shortcut.register('Command+1', {autoRegister: true}, handler);
Shortcut.unregister();

Shortcut(events, [options], handler)

events

Type: string or 'array'

Names for shortcut to register as global shortcut

options

  • autoRegister: default: true, Auto un/register shortcuts on windows got focus.
  • cmdOrCtrl: default: false, All events of Command or Cmd will be changed into Control or Ctrl by OS running your application on

handler

Global event handler for events

register()

Register shortcuts with shortcut list already added.

unregister()

Unregister shortcuts with shortcut list already added.

add(events, [options], handler)

Add a new shortcut

remove(events)

Remove a shortcut. If events is not set, remove all of events.

get(events)

Return array of shortcut by event names

set(events, [options], handler)

Update shortcut with new options by event name

Shortcut.register(events, [options], handler)

Register events with static method. See Shortcut for more information of arguments.

Shortcut.unregister([events])

Unregister events with static method

License

MIT © ragingwind

Install

npm i electron-shortcut

DownloadsWeekly Downloads

4

Version

0.5.0

License

MIT

Last publish

Collaborators

  • avatar