electron-window-shortcut/index.js

Lets make BrowserWindow based Shortcut in Electron App great again

/**
 * Register Shortcut Accelerators
 * Unregister Shortcut Accelerators
 * Attach key event listener to electron Browser Window
 */

const isValidAccelerator = require("electron-is-accelerator");
const {toKeyEvent} = require('keyboardevent-from-electron-accelerator');
const keyEventsAreEqual = require('keyboardevents-areequal');

const acceleratorKeyEventMap = new Map();
const acceleratorCallbackMap = new Map();
const webContentsMap = new Map();

const toStandardKeyEvent = (input) => {
	const standardKeyEvent = {
		code: input.code,
		key: input.key
	};

	['alt', 'shift', 'meta'].forEach(prop => {
		if (typeof input[prop] !== 'undefined') {
			standardKeyEvent[`${prop}Key`] = input[prop];
		}
	});

	if (typeof input.control !== 'undefined') {
		standardKeyEvent.ctrlKey = input.control;
	}

	return standardKeyEvent;
};

const handleCallback = (accelerator, event) => {
    if(acceleratorCallbackMap.has(accelerator)) {
        let cb = acceleratorCallbackMap.get(accelerator);
        cb(event);
    }
};

const inputEventHandler = (event, input) => {
    if (input.type === 'keyUp') {
        return;
    }
    let keyEvent = toStandardKeyEvent(input);
    acceleratorKeyEventMap.forEach((acceleratorKeyEvent, accelerator) => {
        if(keyEventsAreEqual(keyEvent, acceleratorKeyEvent)) {
            handleCallback(accelerator, event);
            return;
        }
    });
};

const register = (accelerator, cb) => {
    if (Array.isArray(accelerator)){
        accelerator.forEach(accelerator => register(accelerator, cb));
        return;
    }
    if(isValidAccelerator(accelerator) && typeof cb === 'function') {
        acceleratorKeyEventMap.set(accelerator, toKeyEvent(accelerator));
        acceleratorCallbackMap.set(accelerator, cb);
    }
};

const unregister = (accelerator) => {
    if(isValidAccelerator(accelerator)) {
        acceleratorKeyEventMap.delete(accelerator);
        acceleratorCallbackMap.delete(accelerator);
    }
};

const attachToWebContent = (webContents) => {
    let id = webContents.id;
    if (webContents && !webContentsMap.has(id)) {
        webContentsMap.set(id, Date.now());
        webContents.on('before-input-event', inputEventHandler);
    }
};

module.exports = {
    register,
    unregister,
    attachToWebContent
};