KeyboardEvent objects describe a user interaction with the keyboard; each event describes a single interaction between the user and a key (or combination of a key with modifier keys) on the keyboard.

interface KeyboardEvent {
    AT_TARGET: number;
    BUBBLING_PHASE: number;
    CAPTURING_PHASE: number;
    DOM_KEY_LOCATION_LEFT: number;
    DOM_KEY_LOCATION_NUMPAD: number;
    DOM_KEY_LOCATION_RIGHT: number;
    DOM_KEY_LOCATION_STANDARD: number;
    NONE: number;
    altKey: boolean;
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    charCode: number;
    code: string;
    composed: boolean;
    ctrlKey: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    detail: number;
    eventPhase: number;
    isComposing: boolean;
    isTrusted: boolean;
    key: string;
    keyCode: number;
    location: number;
    metaKey: boolean;
    repeat: boolean;
    returnValue: boolean;
    shiftKey: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    view: null | Window;
    which: number;
    composedPath(): EventTarget[];
    getModifierState(keyArg: string): boolean;
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    initKeyboardEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: null | Window, keyArg?: string, locationArg?: number, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, metaKey?: boolean): void;
    initUIEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: null | Window, detailArg?: number): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

AT_TARGET: number
BUBBLING_PHASE: number
CAPTURING_PHASE: number
DOM_KEY_LOCATION_LEFT: number
DOM_KEY_LOCATION_NUMPAD: number
DOM_KEY_LOCATION_RIGHT: number
DOM_KEY_LOCATION_STANDARD: number
NONE: number
altKey: boolean
bubbles: 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.

cancelBubble: boolean
cancelable: 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.

charCode: number
code: string
composed: 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.

ctrlKey: boolean
currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

detail: number
eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

isComposing: boolean
isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

key: string
keyCode: number
location: number
metaKey: boolean
repeat: boolean
returnValue: boolean
shiftKey: boolean
srcElement: null | EventTarget
target: null | EventTarget

Returns the object to which event is dispatched (its target).

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

view: null | Window
which: number

Methods

  • 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.

    Returns EventTarget[]

  • Parameters

    • keyArg: string

    Returns boolean

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

  • Parameters

    • typeArg: string
    • OptionalbubblesArg: boolean
    • OptionalcancelableArg: boolean
    • OptionalviewArg: null | Window
    • OptionalkeyArg: string
    • OptionallocationArg: number
    • OptionalctrlKey: boolean
    • OptionalaltKey: boolean
    • OptionalshiftKey: boolean
    • OptionalmetaKey: boolean

    Returns void

  • Parameters

    • typeArg: string
    • OptionalbubblesArg: boolean
    • OptionalcancelableArg: boolean
    • OptionalviewArg: null | Window
    • OptionaldetailArg: number

    Returns 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.

    Returns 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.

    Returns void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void