KeyboardEvent

Properties

Property	Modifier	Type	Description	Inherited from
`AT_TARGET`	`readonly`	`2`	-	`globalThis.KeyboardEvent.AT_TARGET` `UIEvent`.`AT_TARGET`
`bubbles`	`readonly`	`boolean`	Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. MDN Reference	`globalThis.KeyboardEvent.bubbles` `UIEvent`.`bubbles`
`BUBBLING_PHASE`	`readonly`	`3`	-	`globalThis.KeyboardEvent.BUBBLING_PHASE` `UIEvent`.`BUBBLING_PHASE`
`cancelable`	`readonly`	`boolean`	Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. MDN Reference	`globalThis.KeyboardEvent.cancelable` `UIEvent`.`cancelable`
~~`cancelBubble`~~	`public`	`boolean`	Deprecated MDN Reference	`globalThis.KeyboardEvent.cancelBubble` `UIEvent`.`cancelBubble`
`CAPTURING_PHASE`	`readonly`	`1`	-	`globalThis.KeyboardEvent.CAPTURING_PHASE` `UIEvent`.`CAPTURING_PHASE`
~~`charCode`~~	`readonly`	`number`	Deprecated MDN Reference	-
`composed`	`readonly`	`boolean`	Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. MDN Reference	`globalThis.KeyboardEvent.composed` `UIEvent`.`composed`
`currentTarget`	`readonly`	`null` \| `EventTarget`	Returns the object whose event listener's callback is currently being invoked. MDN Reference	`globalThis.KeyboardEvent.currentTarget` `UIEvent`.`currentTarget`
`defaultPrevented`	`readonly`	`boolean`	Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. MDN Reference	`globalThis.KeyboardEvent.defaultPrevented` `UIEvent`.`defaultPrevented`
`detail`	`readonly`	`number`	MDN Reference	`globalThis.KeyboardEvent.detail` `UIEvent`.`detail`
`DOM_KEY_LOCATION_LEFT`	`readonly`	`1`	-	-
`DOM_KEY_LOCATION_NUMPAD`	`readonly`	`3`	-	-
`DOM_KEY_LOCATION_RIGHT`	`readonly`	`2`	-	-
`DOM_KEY_LOCATION_STANDARD`	`readonly`	`0`	-	-
`eventPhase`	`readonly`	`number`	Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. MDN Reference	`globalThis.KeyboardEvent.eventPhase` `UIEvent`.`eventPhase`
`isComposing`	`readonly`	`boolean`	MDN Reference	-
`isTrusted`	`readonly`	`boolean`	Returns true if event was dispatched by the user agent, and false otherwise. MDN Reference	`globalThis.KeyboardEvent.isTrusted` `UIEvent`.`isTrusted`
~~`keyCode`~~	`readonly`	`number`	Deprecated MDN Reference	-
`location`	`readonly`	`number`	MDN Reference	-
`NONE`	`readonly`	`0`	-	`globalThis.KeyboardEvent.NONE` `UIEvent`.`NONE`
`repeat`	`readonly`	`boolean`	MDN Reference	-
~~`returnValue`~~	`public`	`boolean`	Deprecated MDN Reference	`globalThis.KeyboardEvent.returnValue` `UIEvent`.`returnValue`
~~`srcElement`~~	`readonly`	`null` \| `EventTarget`	Deprecated MDN Reference	`globalThis.KeyboardEvent.srcElement` `UIEvent`.`srcElement`
`target`	`readonly`	`null` \| `EventTarget`	Returns the object to which event is dispatched (its target). MDN Reference	`globalThis.KeyboardEvent.target` `UIEvent`.`target`
`timeStamp`	`readonly`	`number`	Returns the event's timestamp as the number of milliseconds measured relative to the time origin. MDN Reference	`globalThis.KeyboardEvent.timeStamp` `UIEvent`.`timeStamp`
`type`	`readonly`	`string`	Returns the type of event, e.g. "click", "hashchange", or "submit". MDN Reference	`globalThis.KeyboardEvent.type` `UIEvent`.`type`
`view`	`readonly`	`null`	MDN Reference	`globalThis.KeyboardEvent.view` `UIEvent`.`view`
~~`which`~~	`readonly`	`number`	Deprecated MDN Reference	`globalThis.KeyboardEvent.which` `UIEvent`.`which`
`AT_TARGET`	`readonly`	`2`	-	`UIEvent`.`AT_TARGET`
`BUBBLING_PHASE`	`readonly`	`3`	-	`UIEvent`.`BUBBLING_PHASE`
`CAPTURING_PHASE`	`readonly`	`1`	-	`UIEvent`.`CAPTURING_PHASE`
`NONE`	`readonly`	`0`	-	`UIEvent`.`NONE`

Accessors

altKey

get altKey(): boolean

MDN Reference

code

get code(): string

MDN Reference

ctrlKey

get ctrlKey(): boolean

MDN Reference

key

get key(): string

MDN Reference

metaKey

get metaKey(): boolean

MDN Reference

shiftKey

get shiftKey(): boolean

MDN Reference

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

MDN Reference

Returns

EventTarget[]

Implementation of

globalThis.KeyboardEvent.composedPath

Inherited from

UIEvent.composedPath

getModifierState()

getModifierState(): boolean

MDN Reference

Returns

boolean

Implementation of

globalThis.KeyboardEvent.getModifierState

initEvent()

initEvent(type, bubbles?, cancelable?): void

Parameters

Parameter	Type
`type`	`string`
`bubbles`?	`boolean`
`cancelable`?	`boolean`

Returns

void

Implementation of

globalThis.KeyboardEvent.initEvent

Inherited from

UIEvent.initEvent

Deprecated

MDN Reference

initKeyboardEvent()

initKeyboardEvent(): void

Returns

void

Implementation of

globalThis.KeyboardEvent.initKeyboardEvent

Deprecated

MDN Reference

initUIEvent()

initUIEvent(): void

Returns

void

Implementation of

globalThis.KeyboardEvent.initUIEvent

Inherited from

UIEvent.initUIEvent

Deprecated

MDN Reference

preventDefault()

preventDefault(): void

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns

void

Implementation of

globalThis.KeyboardEvent.preventDefault

Inherited from

UIEvent.preventDefault

stopImmediatePropagation()

stopImmediatePropagation(): void

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

KeyboardEvent

On this page