Web/API/KeyboardEvent/KeyboardEvent

The KeyboardEvent() constructor creates a new KeyboardEvent.

Syntax

 event = new KeyboardEvent(typeArg, KeyboardEventInit);

Values

typeArg

Is a DOMString representing the name of the event.

KeyboardEventInitOptional

Is a KeyboardEventInit dictionary, having the following fields:

• "key", optional and defaulting to "", of type DOMString, that sets the value of KeyboardEvent.key.
• "code", optional and defaulting to "", of type DOMString, that sets the value of KeyboardEvent.code.
• "location", optional and defaulting to 0, of type unsigned long, that sets the value of KeyboardEvent.location.
• "ctrlKey", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.ctrlKey.
• "shiftKey", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.shiftKey.
• "altKey", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.altKey.
• "metaKey", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.metaKey.
• "repeat", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.repeat.
• "isComposing", optional and defaulting to false, of type Boolean, that sets the value of KeyboardEvent.isComposing.
• "charCode", optional and defaulting to 0, of type unsigned long, that sets the value of the deprecated KeyboardEvent.charCode.
• "keyCode", optional and defaulting to 0, of type unsigned long, that sets the value of the deprecated KeyboardEvent.keyCode.
• "which", optional and defaulting to 0, of type unsigned long, that sets the value of the deprecated KeyboardEvent.which.

The KeyboardEventInit dictionary also accepts fields from the UIEventInit and EventInit dictionaries.

Specifications

Specification	Status	Comment
UI EventsThe definition of 'KeyboardEvent()' in that specification.	Working Draft	Current definition.
Document Object Model (DOM) Level 3 Events SpecificationThe definition of 'KeyboardEvent()' in that specification.	Obsolete	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
KeyboardEvent() constructor	Chrome Full support Yes	Edge Full support ≤79	Firefox Full support 31	IE No support No	Opera Full support Yes	Safari ?	WebView Android Full support Yes	Chrome Android Full support Yes	Firefox Android Full support 31	Opera Android Full support Yes	Safari iOS ?	Samsung Internet Android Full support Yes
Added code and key to KeyboardEventInit	Chrome Full support 49	Edge Full support ≤79	Firefox ?	IE No support No	Opera ?	Safari ?	WebView Android Full support 49	Chrome Android Full support 49	Firefox Android ?	Opera Android ?	Safari iOS ?	Samsung Internet Android Full support 5.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

See also

• KeyboardEvent, the interface of the objects it constructs.

KeyboardEvent() by Mozilla Contributors is licensed under CC-BY-SA 2.5.