Keyboard

keyboard is a utility JavaScript library for keyboard event.

Introduction

Installation

Yarn

yarn add @pluginjs/keyboard

NPM

npm i @pluginjs/keyboard

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/keyboard/dist/keyboard.js"></script>

Production:

<script src="https://unpkg.com/@pluginjs/keyboard/dist/keyboard.min.js"></script>

API

registerEvent

mount keydown keyup event listener on this.element.

handler

Parameters

| Name | Type | Description | |||-| | e | Event | |

on

Parameters

| Name | Type | Description | |||-| | action | String | | | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

off

Parameters

| Name | Type | Description | |||-| | action | String | | | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

dispatch

Parameters

| Name | Type | Description | |||-| | toggle | Boolean | | | action | String | | | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

parseKeys

Parameters

| Name | Type | Description | |||-| | keys | String[] | |

Returns

| Name | Type | Description | |||-| | newKeys | String[] | |

processKey

Parameters

| Name | Type | Description | |||-| | key | String | |

Returns

| Name | Type | Description | |||-| | newKeys | String[] | |

processModifiers

Parameters

| Name | Type | Description | |||-| | key | String | |

Returns

| Name | Type | Description | |||-| | modifiers | Function[] | |

distribute

Parameters

| Name | Type | Description | |||-| | action | String | | | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

getKeyName

Parameters

| Name | Type | Description | |||-| | keyCode | String | |

Returns

| Name | Type | Description | |||-| | keyName | String | |

getKeyCode

Parameters

| Name | Type | Description | |||-| | keyName | String | |

Returns

| Name | Type | Description | |||-| | keyCode | String | |

up

Parameters

| Name | Type | Description | |||-| | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

down

Parameters

| Name | Type | Description | |||-| | key | String | | | func | Function | |

Returns

| Name | Type | Description | |||-| | instance | Object | this |

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/keyboard is Licensed under the GPL-v3 license.

If you want to use @pluginjs/keyboard project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.