Event

interface

interface Event

An event which takes place in the DOM.

variable

var Event: { … }

An event which takes place in the DOM.

Constructors

constructor

new Event(type: string, eventInitDict?: EventInit): Event

Properties

bubbles

readonly 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

Deprecated.

cancelable

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

composed

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

currentTarget

readonly currentTarget: EventTarget | null

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

defaultPrevented

readonly defaultPrevented: boolean

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

eventPhase

readonly eventPhase: number

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

isTrusted

readonly isTrusted: boolean

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

returnValue

returnValue: boolean

Deprecated.

srcElement

readonly srcElement: EventTarget | null

Deprecated.

target

readonly target: EventTarget | null

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

timeStamp

readonly timeStamp: number

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

type

readonly type: string

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

NONE

readonly NONE: 0
readonly NONE: 0

CAPTURING_PHASE

readonly CAPTURING_PHASE: 1
readonly CAPTURING_PHASE: 1

AT_TARGET

readonly AT_TARGET: 2
readonly AT_TARGET: 2

BUBBLING_PHASE

readonly BUBBLING_PHASE: 3
readonly BUBBLING_PHASE: 3

prototype

readonly prototype: Event

Methods

composedPath

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.

initEvent

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

Deprecated.

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.

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.

stopPropagation

stopPropagation(): void

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