mirror of
https://github.com/hodgef/simple-keyboard.git
synced 2024-10-07 00:08:20 +08:00
25 lines
809 B
TypeScript
25 lines
809 B
TypeScript
import { KeyboardOptions, PhysicalKeyboardParams } from "../interfaces";
|
|
/**
|
|
* Physical Keyboard Service
|
|
*/
|
|
declare class PhysicalKeyboard {
|
|
getOptions: () => KeyboardOptions;
|
|
dispatch: any;
|
|
/**
|
|
* Creates an instance of the PhysicalKeyboard service
|
|
*/
|
|
constructor({ dispatch, getOptions }: PhysicalKeyboardParams);
|
|
handleHighlightKeyDown(event: KeyboardEvent): void;
|
|
handleHighlightKeyUp(event: KeyboardEvent): void;
|
|
/**
|
|
* Transforms a KeyboardEvent's "key.code" string into a simple-keyboard layout format
|
|
* @param {object} event The KeyboardEvent
|
|
*/
|
|
getSimpleKeyboardLayoutKey(event: KeyboardEvent): string;
|
|
/**
|
|
* Retrieve key from keyCode
|
|
*/
|
|
keyCodeToKey(keyCode: number): string | undefined;
|
|
}
|
|
export default PhysicalKeyboard;
|