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

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

See also

• KeyboardEvent, the interface of the objects it constructs.