Hotkey Addon

Register global keyboard shortcuts that fire even when the widget is not focused.

import { addon } from "novadesk";
const hotkey = addon.load("path/to/Hotkey.dll");

Table of Contents

---

hotkey.register(hotkeyString, handler) #

Hotkey

Registers a global hotkey and returns an ID you can use to unregister it later. Always store the returned ID.

Supported modifier tokens:

Token	Aliases
CTRL	CONTROL
ALT	—
SHIFT	—
WIN	WINDOWS

Supported key tokens:

Category	Values
Letters	A–Z
Digits	0–9
Function keys	F1–F24
Named keys	SPACE, ENTER/RETURN, TAB, ESC/ESCAPE, BACKSPACE, DELETE/DEL, INSERT/INS, HOME, END, PAGEUP/PGUP, PAGEDOWN/PGDN, LEFT, RIGHT, UP, DOWN

PARAMETERS

hotkeyString string

Hotkey expression, e.g. CTRL+SHIFT+M or ALT+F4. Tokens are case-insensitive and joined with +.

handler function | object

A callback function (fires on key down), or an object with optional onKeyDown and onKeyUp callbacks.

RETURNS: number A registration ID (number). Returns -1 if registration fails.

import { addon } from "novadesk";
const hotkey = addon.load("path/to/Hotkey.dll");

// Simple — fires on key down
const id = hotkey.register("CTRL+SHIFT+M", () => {
  console.log("Hotkey pressed");
});

// With separate down/up handlers
const id2 = hotkey.register("ALT+SPACE", {
  onKeyDown: () => console.log("ALT+SPACE down"),
  onKeyUp:   () => console.log("ALT+SPACE up")
});

console.log("Registered IDs:", id, id2);

---

hotkey.unregister(id) #

Hotkey

Unregisters a previously registered global hotkey.

PARAMETERS

id number

Registration ID returned by hotkey.register().

RETURNS: boolean true if the hotkey was found and removed, false if the ID was not found.

const id = hotkey.register("CTRL+SHIFT+M", () => console.log("fired"));

// Later, remove it
const ok = hotkey.unregister(id);
console.log("Removed:", ok);