https://github.com/daybrush/keycon

Keyboard Controller
https://github.com/daybrush/keycon

Last synced: 3 months ago
JSON representation

Keyboard Controller

• Host: GitHub
• URL: https://github.com/daybrush/keycon
• Owner: daybrush
• Created: 2019-04-11T14:39:44.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-01T14:42:15.000Z (about 1 year ago)
• Last Synced: 2024-03-04T21:11:39.620Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.32 MB
• Stars: 38
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Lists

• awesome-stars - keycon - Keyboard Controller (TypeScript)

README

        
# keycon  [![npm version](https://badge.fury.io/js/keycon.svg)](https://badge.fury.io/js/keycon) 

Keyboard Controller

* [API Documentation](https://daybrush.com/keycon/release/latest/doc/)

### Frameworks

* [React](https://github.com/daybrush/keycon/tree/master/packages/react-keycon)

* [Vue2](https://github.com/daybrush/keycon/tree/master/packages/vue2-keycon)

* [Vue3](https://github.com/daybrush/keycon/tree/master/packages/vue-keycon)

* [Svelte](https://github.com/daybrush/keycon/tree/master/packages/svelte-keycon)

## Installation

```

npm i keycon

```

```html

```

## How to use

```js

import KeyController, { getCombi, getKey } from "keycon";

const keycon = new KeyController();

// The focus went out of the browser.

keycon.on("blur", () => {

    console.log("blur");

});

// keydown all

keycon.keydown(e => {

    console.log(e);

});

// keydown space

keycon.keydown("space", e => {

    console.log(e);

});

// keydown alt + space combination

keycon.keydown(["alt", "space"], e => {

    // ["alt", "space"]

    console.log(getCombi(e));

    // "space"

    console.log(getKey(e.keyCode));

    console.log(e);

});

// keyup all

keycon.keyup(e => {

    console.log(e);

});

// keyup space

keycon.keydown("space", e => {

    console.log(e);

});

// keyup alt + space combination

keycon.keyup(["alt", "space"], e => {

    console.log(e);

});

```