https://github.com/parro-it/keyboardevent-from-electron-accelerator

Transform an Electron Accelerator string into a DOM KeyboardEvent.
https://github.com/parro-it/keyboardevent-from-electron-accelerator

Last synced: 12 months ago
JSON representation

Transform an Electron Accelerator string into a DOM KeyboardEvent.

• Host: GitHub
• URL: https://github.com/parro-it/keyboardevent-from-electron-accelerator
• Owner: parro-it
• License: mit
• Created: 2017-06-25T20:38:16.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:36:46.000Z (over 3 years ago)
• Last Synced: 2025-04-12T22:36:02.903Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 1.35 MB
• Stars: 14
• Watchers: 3
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: license

Awesome Lists containing this project

README

          
# keyboardevent-from-electron-accelerator

[![Travis Build Status](https://img.shields.io/travis/parro-it/keyboardevent-from-electron-accelerator/master.svg)](http://travis-ci.org/parro-it/keyboardevent-from-electron-accelerator)

[![NPM downloads](https://img.shields.io/npm/dt/keyboardevent-from-electron-accelerator.svg)](https://npmjs.org/package/keyboardevent-from-electron-accelerator)

[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/l1qdd90e7xagkgq7/branch/master?svg=true)](https://ci.appveyor.com/project/parro-it/keyboardevent-from-electron-accelerator/branch/master)

> Transform an Electron Accelerator string into a DOM KeyboardEvent.

This module export a function that take an Electron Accelerator as input

and return a corresponding KeyboardEvent object.

E.g. `'Ctrl+Alt+C' => {code: 'c', ctrlKey: true, altKey: true}`

## Usage

This example convert a string containing an Electron Accelerator to a corresponding KeyboardEvent object. Returned object is the keyevent that would be emitted if that key combination was pressed.

```js

const {toKeyEvent} = require('keyboardevent-from-electron-accelerator');

console.log(toKeyEvent('Shift+Delete'));

```

This will output

    {key: 'Delete', shiftKey: true}

## Context and motivation for this module.

This module is part of an ongoing effort to make [electron-localshortcut](https://github.com/parro-it/electron-localshortcut) less error prone, using keyboard DOM listener instead of 'globalShortcut' method to trigger shortcuts handlers.

`electron-localshortcut` will listen for DOM `keydown` and `keyup` events, and will

trigger shortcuts handlers if emitted DOM events match the Accelerator.

This module wrap the core logic of that match operation.

You can help by testing the module on [runkit](https://npm.runkit.com/keyboardevent-from-electron-accelerator) and [opening an issue](https://github.com/parro-it/keyboardevent-from-electron-accelerator/issues/new) if you found some wrong

result.

## API

### toKeyEvent

This function transform an Electron Accelerator string into

a DOM KeyboardEvent object.

**Parameters**

-   `accelerator` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** an Electron Accelerator string, e.g. `Ctrl+C` or `Shift+Space`.

Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** a DOM KeyboardEvent object derivate from the `accelerator` argument.

## Install

With [npm](https://npmjs.org/) installed, run

    $ npm install keyboardevent-from-electron-accelerator

## See Also

-   [`noffle/common-readme`](https://github.com/noffle/common-readme)

## License

MIT