Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

AT_TARGET

AT_TARGET: number

BUBBLING_PHASE

BUBBLING_PHASE: number

CAPTURING_PHASE

CAPTURING_PHASE: number

DOM_KEY_LOCATION_LEFT

DOM_KEY_LOCATION_LEFT: number

DOM_KEY_LOCATION_NUMPAD

DOM_KEY_LOCATION_NUMPAD: number

DOM_KEY_LOCATION_RIGHT

DOM_KEY_LOCATION_RIGHT: number

DOM_KEY_LOCATION_STANDARD

DOM_KEY_LOCATION_STANDARD: number

NONE

NONE: number

UIEvent

UIEvent: object

Type declaration

  • constructor: function
    • Parameters

      Returns UIEvent

  • prototype: UIEvent

altKey

altKey: boolean

bubbles

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

cancelBubble: boolean

cancelable

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.

char

char: string
deprecated

charCode

charCode: number
deprecated

code

code: string

composed

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

ctrlKey: boolean

currentTarget

currentTarget: EventTarget | null

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

defaultPrevented

defaultPrevented: boolean

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

detail

detail: number

eventPhase

eventPhase: number

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

isComposing

isComposing: boolean

isTrusted

isTrusted: boolean

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

key

key: string

keyCode

keyCode: number
deprecated

location

location: number

metaKey

metaKey: boolean

repeat

repeat: boolean

returnValue

returnValue: boolean

shiftKey

shiftKey: boolean

srcElement

srcElement: EventTarget | null
deprecated

target

target: EventTarget | null

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

timeStamp

timeStamp: number

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

type

type: string

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

view

view: Window | null

which

which: number
deprecated

Methods

composedPath

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

getModifierState

  • getModifierState(keyArg: string): boolean
  • Parameters

    • keyArg: string

    Returns boolean

initEvent

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

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

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.

    Returns void

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.

    Returns void

stopPropagation

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

    Returns void

Generated using TypeDoc