import type { WindowEventName } from "../utils/basic.cjs";
export type KeyModifier = 'Alt' | 'AltGraph' | 'CapsLock' | 'Control' | 'Fn' | 'FnLock' | 'Meta' | 'NumLock' | 'ScrollLock' | 'Shift' | 'Symbol' | 'SymbolLock';
export interface UseModifierOptions<Initial> {
    /**
     * Event names that will prompt update to modifier states
     *
     * @defaultValue ['mousedown', 'mouseup', 'keydown', 'keyup']
     */
    events?: WindowEventName[];
    /**
     * Initial value of the returned ref
     *
     * @defaultValue null
     */
    initial?: Initial;
}
export type UseKeyModifierReturns<Initial> = Initial extends boolean ? boolean : boolean | null;
/**
 * A React Hook that allows you to detect if a [key modifier](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState) is pressed.
 */
export declare function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options?: UseModifierOptions<Initial>): UseKeyModifierReturns<Initial>;