@lesnoypudge/utils-react/build/hooks/useHotKey/useHotKey.d.ts

lesnoypudge's utils-react

import { useEventListener } from '../useEventListener';
import { hotKey } from '@lesnoypudge/utils-web';
export declare namespace useHotKey {
    type ElementType = useEventListener.ElementUnion;
    type Element<_ElementType extends ElementType> = useEventListener.ProvidedElement<_ElementType>;
    type KeyCombo = hotKey.KeyCombo;
    type KeyCombos = KeyCombo[];
    type Handler = (e: KeyboardEvent) => void;
    type Options = {
        eventListenerOption?: AddEventListenerOptions;
        hotKeyOptions?: hotKey.HotKeyOptions;
    };
}
/**
 * Binds a hotkey event to a DOM element.
 * Executes the provided handler when the key combination is pressed.
 */
export declare const useHotKey: <_ElementType extends useHotKey.ElementType>(element: useHotKey.Element<_ElementType>, keyCombo: useHotKey.KeyCombo | useHotKey.KeyCombos, handler: useHotKey.Handler, options?: useHotKey.Options) => void;