Code Monkey home page Code Monkey logo

electron-hotkey's Introduction

electron-hotkey

Manage shortcuts in Electron.

You can use it in main or renderer process.

Usage

npm install --save electron-hotkey

// in main process
const hotkey = require('electron-hotkey');

// in renderer process
const hotkey = require('electron').remote.require('electron-hotkey');

register(typeOrWindow, accelerator, eventName)

typeOrWindow: 'global', 'local' or a window instance.

hotkey.register('global', 'CommandOrControl+1', 'event-1');
hotkey.register('local', 'CommandOrControl+2', 'event-2');
hotkey.register(myWindow, 'CommandOrControl+3', 'event-3');

app.on('shortcut-pressed', (event) => {
    console.log(event);
});

unregister(accelerator)

unregisterAll()

isRegistered(accelerator)

Return value could be false, 'global', 'local', or a window instance.

load(config)

A config example could be:

const config = [
    {type: 'global', accelerator: 'CommandOrControl+1', event: 'event-1'},
    {type: 'local', accelerator: 'CommandOrControl+2', event: 'event-2'},
    {type: myWindow, accelerator: 'CommandOrControl+3', event: 'event-3'},
];

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.