react-hotkeys-hook/dist/useHotkeys.d.ts

React hook for using keyboard shortcuts in components. This is a hook version for the [hotkeys] package.

import hotkeys, { KeyHandler } from 'hotkeys-js';
import React from 'react';
declare type AvailableTags = 'INPUT' | 'TEXTAREA' | 'SELECT';
export declare type Options = {
    enabled?: boolean;
    filter?: typeof hotkeys.filter;
    filterPreventDefault?: boolean;
    enableOnTags?: AvailableTags[];
    enableOnContentEditable?: boolean;
    splitKey?: string;
    scope?: string;
    keyup?: boolean;
    keydown?: boolean;
};
export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, options?: Options): React.MutableRefObject<T | null>;
export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, deps?: any[]): React.MutableRefObject<T | null>;
export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, options?: Options, deps?: any[]): React.MutableRefObject<T | null>;
export {};