Docs4dev
Docs
dom / latest / keyboardevent / keyboardevent.html

KeyboardEvent: KeyboardEvent() constructor

The KeyboardEvent() constructor creates a new KeyboardEvent object.

Syntax

js

new KeyboardEvent(type)
new KeyboardEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to keydown, keyup, or keypress.

options Optional

An object that, in addition of the properties defined in UIEvent(), can have the following properties:

key Optional

A string, defaulting to "", that sets the value of KeyboardEvent.key.

code Optional

A string, defaulting to "", that sets the value of KeyboardEvent.code.

location Optional

A string, defaulting to 0, that sets the value of KeyboardEvent.location.

repeat Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.repeat.

isComposing Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.isComposing.

charCode Optional

A number, defaulting to 0, that sets the value of the deprecated KeyboardEvent.charCode.

keyCode Optional

A number, defaulting to 0, that sets the value of the deprecated KeyboardEvent.keyCode.

which Optional

A number, defaulting to 0, that sets the value of the deprecated UIEvent.which.

ctrlKey Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.ctrlKey.

shiftKey Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.shiftKey.

altKey Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.altKey.

metaKey Optional

A boolean value, defaulting to false, that sets the value of KeyboardEvent.metaKey.

Return value

A new KeyboardEvent object.

Specifications

Specification
UI Events
# dom-keyboardevent-keyboardevent

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
KeyboardEvent 26 12 31 No 15 7 4.4 26 31 14 7 1.5

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent