useKeyPress
A hook that elegantly manages KeyboardEvent of keyup adn keydown, Keyboard key combinations are supported to define key and keyCode alias input for keyboard events.
API is consistent with ahooks.
Examples
Basic usage
Compound mode
Advanced
API
useKeyPress(
keyFilter: KeyFilter,
eventHandler: EventHandler = noop,
options?: Options
)
Params
Tips: keyType is the key or keyCode of KeyboardEvent.
| Property | Description | Type | Default |
|---|---|---|---|
| keyFilter | Support for key and keyCode in keyboard events,function that return Boolean, key aliases | keyType | Array<keyType> | ((event: KeyboardEvent) => boolean) | - |
| eventHandler | Callback Function | (event: KeyboardEvent) => void | () => {} |
| options | advanced options，see Options below | - | - |
Options
| Property | Description | Type | Default |
|---|---|---|---|
| events | Trigger Events | Array<keydown | keyup> | ['keydown'] |
| target | DOM element or Ref Object | (() => HTMLElement) | HTMLElement | React.MutableRefObject | - |
Remarks
1.All key aliases
enter;
tab;
delete ('Backspace', 'Delete');
esc;
space;
up;
down;
left;
right;
2.Modifier keys
ctrl;
alt;
shift;
meta;