Search

Search something to see results

GitHub

KeyboardEvent

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.

MDN Reference

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

Hierarchy (View Summary)

Index

Properties

<internal>.KeyboardEvent.bubbles<internal>.KeyboardEvent.cancelBubble<internal>.KeyboardEvent.cancelable<internal>.KeyboardEvent.composed<internal>.KeyboardEvent.currentTarget<internal>.KeyboardEvent.defaultPrevented<internal>.KeyboardEvent.eventPhase<internal>.KeyboardEvent.isTrusted<internal>.KeyboardEvent.returnValue<internal>.KeyboardEvent.srcElement<internal>.KeyboardEvent.target<internal>.KeyboardEvent.timeStamp<internal>.KeyboardEvent.type<internal>.KeyboardEvent.NONE<internal>.KeyboardEvent.CAPTURING_PHASE<internal>.KeyboardEvent.AT_TARGET<internal>.KeyboardEvent.BUBBLING_PHASE<internal>.KeyboardEvent.altKey<internal>.KeyboardEvent.charCode<internal>.KeyboardEvent.code<internal>.KeyboardEvent.ctrlKey<internal>.KeyboardEvent.isComposing<internal>.KeyboardEvent.key<internal>.KeyboardEvent.keyCode<internal>.KeyboardEvent.location<internal>.KeyboardEvent.metaKey<internal>.KeyboardEvent.repeat<internal>.KeyboardEvent.shiftKey<internal>.KeyboardEvent.DOM_KEY_LOCATION_STANDARD<internal>.KeyboardEvent.DOM_KEY_LOCATION_LEFT<internal>.KeyboardEvent.DOM_KEY_LOCATION_RIGHT<internal>.KeyboardEvent.DOM_KEY_LOCATION_NUMPAD<internal>.KeyboardEvent.detail<internal>.KeyboardEvent.view<internal>.KeyboardEvent.which

Methods

<internal>.KeyboardEvent.composedPath<internal>.KeyboardEvent.initEvent<internal>.KeyboardEvent.preventDefault<internal>.KeyboardEvent.stopImmediatePropagation<internal>.KeyboardEvent.stopPropagation<internal>.KeyboardEvent.getModifierState<internal>.KeyboardEvent.initKeyboardEvent<internal>.KeyboardEvent.initUIEvent

Properties

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.

MDN Reference

cancelBubble: boolean

MDN Reference

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.

MDN Reference

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.

MDN Reference

currentTarget: null | EventTarget

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

MDN Reference

defaultPrevented: boolean

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

MDN Reference

eventPhase: number

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

MDN Reference

isTrusted: boolean

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

MDN Reference

returnValue: boolean

MDN Reference

srcElement: null | EventTarget

MDN Reference

target: null | EventTarget

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

MDN Reference

timeStamp: number

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

MDN Reference

type: string

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

MDN Reference

NONE: 0
CAPTURING_PHASE: 1
AT_TARGET: 2
BUBBLING_PHASE: 3
altKey: boolean

MDN Reference

charCode: number

MDN Reference

code: string

MDN Reference

ctrlKey: boolean

MDN Reference

isComposing: boolean

MDN Reference

key: string

MDN Reference

keyCode: number

MDN Reference

location: number

MDN Reference

metaKey: boolean

MDN Reference

repeat: boolean

MDN Reference

shiftKey: boolean

MDN Reference

DOM_KEY_LOCATION_STANDARD: 0
DOM_KEY_LOCATION_LEFT: 1
DOM_KEY_LOCATION_RIGHT: 2
DOM_KEY_LOCATION_NUMPAD: 3
detail: number

MDN Reference

view: null | Window

MDN Reference

which: number

MDN Reference

Methods

composedPath(): EventTarget[]

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[]

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

Parameters

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

Returns void

MDN Reference

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

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

Returns void

stopPropagation(): void

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

MDN Reference

Returns void

getModifierState(keyArg: string): boolean

MDN Reference

Parameters

  • keyArg: string

Returns boolean

initKeyboardEvent(
    typeArg: string,
    bubblesArg?: boolean,
    cancelableArg?: boolean,
    viewArg?: null | Window,
    keyArg?: string,
    locationArg?: number,
    ctrlKey?: boolean,
    altKey?: boolean,
    shiftKey?: boolean,
    metaKey?: boolean,
): 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

MDN Reference

initUIEvent(
    typeArg: string,
    bubblesArg?: boolean,
    cancelableArg?: boolean,
    viewArg?: null | Window,
    detailArg?: number,
): void

Parameters

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

Returns void

MDN Reference