UIEvent: initUIEvent() method - Web APIs | MDN

Syntax

js

initUIEvent(type, canBubble, cancelable, view, detail)

Parameters

type

A string defining the type of event.

canBubble

A boolean value deciding whether the event should bubble up through the event chain or not. Once set, the read-only property Event.bubbles will give its value.

cancelable

A boolean value defining whether the event can be canceled. Once set, the read-only property Event.cancelable will give its value.

view

Is the WindowProxy associated with the event.

detail

An unsigned long specifying some detail information about the event, depending on the type of event. For mouse events, it indicates how many times the mouse has been clicked on a given screen location.

Return value

None (undefined).

Examples

js

const e = document.createEvent("UIEvent");
// creates a click event that bubbles, can be cancelled,
// and with its view and detail property initialized to window and 1,
// respectively
e.initUIEvent("click", true, true, window, 1);

Specifications

Specification
UI Events
# dom-uievent-inituievent

Browser compatibility

See also

  • UIEvent
  • The constructor to use instead of this deprecated method: UIEvent(). More specific constructors can be used too.

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.