useHotkeys.d.ts 901 B

123456789101112131415161718
  1. import hotkeys, { KeyHandler } from 'hotkeys-js';
  2. import React from 'react';
  3. declare type AvailableTags = 'INPUT' | 'TEXTAREA' | 'SELECT';
  4. export declare type Options = {
  5. enabled?: boolean;
  6. filter?: typeof hotkeys.filter;
  7. filterPreventDefault?: boolean;
  8. enableOnTags?: AvailableTags[];
  9. enableOnContentEditable?: boolean;
  10. splitKey?: string;
  11. scope?: string;
  12. keyup?: boolean;
  13. keydown?: boolean;
  14. };
  15. export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, options?: Options): React.MutableRefObject<T | null>;
  16. export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, deps?: any[]): React.MutableRefObject<T | null>;
  17. export declare function useHotkeys<T extends Element>(keys: string, callback: KeyHandler, options?: Options, deps?: any[]): React.MutableRefObject<T | null>;
  18. export {};