You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
1.3 KiB
TypeScript
54 lines
1.3 KiB
TypeScript
export interface HotkeysEvent {
|
|
key: string;
|
|
method: KeyHandler;
|
|
mods: number[];
|
|
scope: string;
|
|
shortcut: string;
|
|
}
|
|
|
|
export interface KeyHandler {
|
|
(keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent): void | boolean;
|
|
}
|
|
|
|
type Options = {
|
|
scope?: string;
|
|
element?: HTMLElement | null;
|
|
keyup?: boolean | null;
|
|
keydown?: boolean | null;
|
|
splitKey?: string;
|
|
}
|
|
|
|
interface Hotkeys {
|
|
(key: string, method: KeyHandler): void;
|
|
(key: string, scope: string, method: KeyHandler): void;
|
|
(key: string, options: Options, method: KeyHandler): void;
|
|
|
|
shift: boolean;
|
|
ctrl: boolean;
|
|
alt: boolean;
|
|
option: boolean;
|
|
control: boolean;
|
|
cmd: boolean;
|
|
command: boolean;
|
|
|
|
setScope(scopeName: string): void;
|
|
getScope(): string;
|
|
deleteScope(scopeName: string): void;
|
|
|
|
noConflict(): Hotkeys;
|
|
|
|
unbind(key?: string): void;
|
|
unbind(key: string, scopeName: string): void;
|
|
unbind(key: string, scopeName: string, method: KeyHandler): void;
|
|
unbind(key: string, method: KeyHandler): void;
|
|
|
|
isPressed(keyCode: number): boolean;
|
|
isPressed(keyCode: string): boolean;
|
|
getPressedKeyCodes(): number[];
|
|
|
|
filter(event: KeyboardEvent): boolean;
|
|
}
|
|
// https://github.com/eiriklv/react-masonry-component/issues/57
|
|
declare var hotkeys: Hotkeys;
|
|
export default hotkeys;
|