14 lines
710 B
TypeScript
14 lines
710 B
TypeScript
import { BasicTarget } from '../utils/dom';
|
|
export declare type KeyPredicate = (event: KeyboardEvent) => boolean;
|
|
export declare type keyType = KeyboardEvent['keyCode'] | KeyboardEvent['key'];
|
|
export declare type KeyFilter = keyType | Array<keyType> | ((event: KeyboardEvent) => boolean);
|
|
export declare type EventHandler = (event: KeyboardEvent) => void;
|
|
export declare type keyEvent = 'keydown' | 'keyup';
|
|
export declare type Target = BasicTarget<HTMLElement | Document | Window>;
|
|
export declare type EventOption = {
|
|
events?: Array<keyEvent>;
|
|
target?: Target;
|
|
};
|
|
declare function useKeyPress(keyFilter: KeyFilter, eventHandler?: EventHandler, option?: EventOption): void;
|
|
export default useKeyPress;
|