Skip to content

Event

Types

eventInit

type eventInit = WebAPI.DOM.eventInit = {
mutable bubbles?: bool,
mutable cancelable?: bool,
mutable composed?: bool,
}

Record fields

bubbles
option<bool>
cancelable
option<bool>
composed
option<bool>

Values

asEvent

let asEvent: WebAPI.DOM.event => WebAPI.DOM.event

bubbles

let bubbles: WebAPI.DOM.event => bool

Parameters

WebAPI.DOM.event

Return type

bool

cancelable

let cancelable: WebAPI.DOM.event => bool

Parameters

WebAPI.DOM.event

Return type

bool

composed

let composed: WebAPI.DOM.event => bool

Parameters

WebAPI.DOM.event

Return type

bool

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. Read more on MDN

let composedPath: WebAPI.DOM.event => array<WebAPI.DOM.eventTarget>

Parameters

WebAPI.DOM.event

Return type

array<WebAPI.DOM.eventTarget>

currentTarget

let currentTarget: WebAPI.DOM.event => Null.t<WebAPI.DOM.eventTarget>

Parameters

WebAPI.DOM.event

Return type

Stdlib.Null.t<WebAPI.DOM.eventTarget>

defaultPrevented

let defaultPrevented: WebAPI.DOM.event => bool

Parameters

WebAPI.DOM.event

Return type

bool

eventPhase

let eventPhase: WebAPI.DOM.event => int

Parameters

WebAPI.DOM.event

Return type

int

isTrusted

let isTrusted: WebAPI.DOM.event => bool

Parameters

WebAPI.DOM.event

Return type

bool

make

let make: (
~type_: string,
~eventInitDict: eventInit=?,
) => WebAPI.DOM.event

Parameters

stringoption<eventInit>

Return type

WebAPI.DOM.event

preventDefault

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. Read more on MDN

let preventDefault: WebAPI.DOM.event => unit

Parameters

WebAPI.DOM.event

Return type

unit

stopImmediatePropagation

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. Read more on MDN

let stopImmediatePropagation: WebAPI.DOM.event => unit

Parameters

WebAPI.DOM.event

Return type

unit

stopPropagation

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

let stopPropagation: WebAPI.DOM.event => unit

Parameters

WebAPI.DOM.event

Return type

unit

target

let target: WebAPI.DOM.event => Null.t<WebAPI.DOM.eventTarget>

Parameters

WebAPI.DOM.event

Return type

Stdlib.Null.t<WebAPI.DOM.eventTarget>

timeStamp

let timeStamp: WebAPI.DOM.event => float

Parameters

WebAPI.DOM.event

Return type

float

type_

let type_: WebAPI.DOM.event => WebAPI.EventType.t