iohook

# Usage

# Electron

Before installing this module, you will need to set a runtime version in your package.json.

When developing with webpack, you will need the Node.js runtime.

In production, your Electron app will need the Electron version.

Checkout your ABI for node.js (opens new window) or electron (opens new window). The example below uses Node.js v12.X and Electron v11.X.

"iohook": {
  "targets": [
    "node-72",
    "electron-85"
  ],
  "platforms": [
    "win32",
    "darwin",
    "linux"
  ],
  "arches": [
    "x64",
    "ia32"
  ]
}

Or you can specify targets as objects:

"iohook": {
  "targets": [
    {
      "target": "node",
      "abi": "72",
      "platform": "darwin",
      "arch": "x64"
    },
    {
      "target": "electron",
      "abi": "85",
      "platform": "win32",
      "arch": "ia32"
    },
  ],

TIP

if you use a two-package.json structure, add this to application package.json.

# Generic Node application

Here is a simple example :

'use strict';

const ioHook = require('iohook');

ioHook.on('mousemove', (event) => {
  console.log(event); // { type: 'mousemove', x: 700, y: 400 }
});

// Register and start hook
ioHook.start();

// Alternatively, pass true to start in DEBUG mode.
ioHook.start(true);

// False to disable DEBUG. Cleaner terminal output.
ioHook.start(false);

# Available events

# keydown

Triggered when user presses a key.

{
  keycode: 46,
  rawcode: 8,
  type: 'keydown',
  altKey: true,
  shiftKey: true,
  ctrlKey: false,
  metaKey: false
}

# keyup

Triggered when user releases a key.

{
  keycode: 19,
  rawcode: 15,
  type: 'keyup',
  altKey: true,
  shiftKey: true,
  ctrlKey: false,
  metaKey: false
}

# mouseclick

Triggered when user clicks a mouse button.

{ button: 1, clicks: 1, x: 545, y: 696, type: 'mouseclick' }

# mousedown

Triggered when user clicks a mouse button.

{ button: 1, clicks: 1, x: 545, y: 696, type: 'mousedown' }

# mouseup

Triggered when user releases a mouse button.

{ button: 1, clicks: 1, x: 545, y: 696, type: 'mouseup' }

# mousemove

Triggered when user moves the mouse.

{ button: 0, clicks: 0, x: 521, y: 737, type: 'mousemove' }

# mousedrag

Triggered when user clicks and drags something.

{ button: 0, clicks: 0, x: 373, y: 683, type: 'mousedrag' }

# mousewheel

Triggered when user uses the mouse wheel.

{ amount: 3, clicks: 1, direction: 3, rotation: 1, type: 'mousewheel', x: 466, y: 683 }

# Shortcuts

You can register global shortcuts.

NOTE

When a shortcut is caught, keyup/keydown events still emit events. It means, that if you register a keyup AND shortcut for ALT+T, both events will be emited.

# registerShortcut(keys, callback, releaseCallback?)

In the next example we register CTRL+F7 shortcut (in MacOS. For other OSes, the keycodes could be different).

const id = ioHook.registerShortcut([29, 65], (keys) => {
  console.log('Shortcut called with keys:', keys);
});

We can also specify a callback to run when our shortcut has been released by specifying a third function argument.

const id = ioHook.registerShortcut(
  [29, 65],
  (keys) => {
    console.log('Shortcut called with keys:', keys);
  },
  (keys) => {
    console.log('Shortcut has been released!');
  }
);

# unregisterShortcut(shortcutId)

You can unregister shortcut by using shortcutId returned by registerShortcut().

ioHook.unregisterShortcut(id);

# unregisterShortcutByKeys(keys)

You can unregister shortcut by using the keys codes passed to registerShortcut(). Passing codes in the same order as during registration is not required.

ioHook.unregisterShortcutByKeys(keys);

# unregisterAllShortcuts()

You can also unregister all shortcuts.

ioHook.unregisterAllShortcuts();

# useRawcode(using)

Some libraries, such as Mousetrap will emit keyboard events that contain a rawcode value. This is a separate, but equally valid, representation of the key that was pressed. However by default iohook instead uses an event's keycode field to determine which key was pressed. If these key codes do not line up, your shortcut will not be detected as pressed.

To tell iohook to use the rawcode value instead, simply do so before starting iohook.

iohook.useRawcode(true);
iohook.start();

# disableClickPropagation()

You can disable mouse click event propagation. Click events are captured and emitted but not propagated to the window.

ioHook.disableClickPropagation();

# enableClickPropagation()

You can enable mouse click event propagation if it's disabled. Click event are propagated by default.

ioHook.enableClickPropagation();

← Manual Build →