What is the TypeScript definition for the onKeyPress event in React?
The right interface for onKeyPress is KeyboardEvent
Please continue reading below to see how to use it or read my guide on using React's events with TypeScript.
Interface
interface KeyboardEvent<T = Element> extends SyntheticEvent<T, NativeKeyboardEvent> {
altKey: boolean;
/** @deprecated */
charCode: number;
ctrlKey: boolean;
getModifierState(key: string): boolean;
key: string;
/** @deprecated */
keyCode: number;
locale: string;
location: number;
metaKey: boolean;
repeat: boolean;
shiftKey: boolean;
/** @deprecated */
which: number;
}Full example
import React, { KeyboardEvent } from 'react';
const App = () => {
const handleKeyboardEvent = (e: KeyboardEvent<HTMLImageElement>) => {
// Do something
};
return <div onKeyPress={handleKeyboardEvent}>{/** Some code */}</div>;
};
export default App;