DOM event


DOM Events are a signal that something has occurred, or is occurring, and can be triggered by user interactions or by the browser. Client-side scripting languages like JavaScript, JScript, VBScript, and Java can register various event handlers or listeners on the element nodes inside a DOM tree, such as in HTML, XHTML, XUL, and SVG documents.
Examples of DOM Events:
  • When a user clicks the mouse
  • When a web page has loaded
  • When an image has been loaded
  • When the mouse moves over an element
  • When an input field is changed
  • When an HTML form is submitted
  • When a user presses a key
Historically, like DOM, the event models used by various web browsers had some significant differences which caused compatibility problems. To combat this, the event model was standardized by the World Wide Web Consortium in DOM Level 2.

Events

HTML events

Common events

There is a huge collection of events that can be generated by most element nodes:
Note that the event classification above is not exactly the same as W3C's classification.
CategoryTypeAttributeDescriptionBubblesCancelable
MouseclickonclickFires when the pointing device button is clicked over an element. A click is defined as a mousedown and mouseup over the same screen location. The sequence of these events is:
  • mousedown
  • mouseup
  • click
MousedblclickondblclickFires when the pointing device button is double-clicked over an element
MousemousedownonmousedownFires when the pointing device button is pressed over an element
MousemouseuponmouseupFires when the pointing device button is released over an element
MousemouseoveronmouseoverFires when the pointing device is moved onto an element
MousemousemoveonmousemoveFires when the pointing device is moved while it is over an element
MousemouseoutonmouseoutFires when the pointing device is moved away from an element
MousedragstartondragstartFired on an element when a drag is started.
MousedragondragThis event is fired at the source of the drag, that is, the element where dragstart was fired, during the drag operation.
MousedragenterondragenterFired when the mouse is first moved over an element while a drag is occurring.
MousedragleaveondragleaveThis event is fired when the mouse leaves an element while a drag is occurring.
MousedragoverondragoverThis event is fired as the mouse is moved over an element when a drag is occurring.
MousedropondropThe drop event is fired on the element where the drop occurs at the end of the drag operation.
MousedragendondragendThe source of the drag will receive a dragend event when the drag operation is complete, whether it was successful or not.
KeyboardkeydownonkeydownFires before keypress, when a key on the keyboard is pressed.
KeyboardkeypressonkeypressFires after keydown, when a key on the keyboard is pressed.
KeyboardkeyuponkeyupFires when a key on the keyboard is released
HTML frame/objectloadonloadFires when the user agent finishes loading all content within a document, including window, frames, objects and imagesFor elements, it fires when the target element and all of its content has finished loading
HTML frame/objectunloadonunloadFires when the user agent removes all content from a window or frame
For elements, it fires when the target element or any of its content has been removed
HTML frame/objectabortonabortFires when an object/image is stopped from loading before completely loaded
HTML frame/objecterroronerrorFires when an object/image/frame cannot be loaded properly
HTML frame/objectresizeonresizeFires when a document view is resized
HTML frame/objectscrollonscrollFires when an element or document view is scrolled, except that a scroll event on document must bubble to the window
HTML formselectonselectFires when a user selects some text in a text field, including input and textarea
HTML formchangeonchangeFires when a control loses the input focus and its value has been modified since gaining focus
HTML formsubmitonsubmitFires when a form is submitted
HTML formresetonresetFires when a form is reset
HTML formfocusonfocusFires when an element receives focus either via the pointing device or by tab navigation
HTML formbluronblurFires when an element loses focus either via the pointing device or by tabbing navigation
User interfacefocusinSimilar to HTML focus event, but can be applied to any focusable element
User interfacefocusoutSimilar to HTML blur event, but can be applied to any focusable element
User interfaceDOMActivateSimilar to XUL command event. Fires when an element is activated, for instance, through a mouse click or a keypress.
MutationDOMSubtreeModifiedFires when the subtree is modified
MutationDOMNodeInsertedFires when a node has been added as a child of another node
MutationDOMNodeRemovedFires when a node has been removed from a DOM-tree
MutationDOMNodeRemovedFromDocumentFires when a node is being removed from a document
MutationDOMNodeInsertedIntoDocumentFires when a node is being inserted into a document
MutationDOMAttrModifiedFires when an attribute has been modified
MutationDOMCharacterDataModifiedFires when the character data has been modified
ProgressloadstartProgress has begun.
ProgressprogressIn progress. After loadstart has been dispatched.
ProgresserrorProgression failed. After the last progress has been dispatched, or after loadstart has been dispatched if progress has not been dispatched.
ProgressabortProgression is terminated. After the last progress has been dispatched, or after loadstart has been dispatched if progress has not been dispatched.
ProgressloadProgression is successful. After the last progress has been dispatched, or after loadstart has been dispatched if progress has not been dispatched.
ProgressloadendProgress has stopped. After one of error, abort, or load has been dispatched.

Note that the events whose names start with "DOM" are currently not well supported, and for this and other performance reasons are deprecated by the W3C in DOM Level 3. Mozilla and Opera support DOMAttrModified, DOMNodeInserted, DOMNodeRemoved and DOMCharacterDataModified. Chrome and Safari support these events, except for DOMAttrModified.

Touch events

Web browsers running on touch-enabled devices, such as Apple's iOS and Google's Android, generate additional events.
CategoryTypeAttributeDescriptionBubblesCancelable
TouchtouchstartFires when a finger is placed on the touch surface/screen.
TouchtouchendFires when a finger is removed from the touch surface/screen.
TouchtouchmoveFires when a finger already placed on the screen is moved across the screen.
TouchtouchenterFires when a touch point moves onto the interactive area defined by a DOM element.
TouchtouchleaveFires when a touch point moves off the interactive area defined by a DOM element.
TouchtouchcancelA user agent must dispatch this event type to indicate when a TouchPoint has been disrupted in an implementation-specific manner, such as by moving outside the bounds of the UA window. A user agent may also dispatch this event type when the user places more touch points on the touch surface than the device or implementation is configured to store, in which case the earliest TouchPoint object in the TouchList should be removed.

In the W3C draft recommendation, a TouchEvent delivers a TouchList of Touch locations, the modifier keys that were active, a TouchList of Touch locations within the targeted DOM element, and a TouchList of Touch locations that have changed since the previous TouchEvent.
Apple didn't join this working group, and delayed W3C recommendation of its Touch Events Specification by disclosing patents late in the recommendation process.

Pointer events

Web browsers on devices with various types of input devices including mouse, touch panel, and pen may generate integrated input events. Users can see what type of input device is pressed, what button is pressed on that device, and how strongly the button is pressed when it comes to a stylus pen. As of October 2013, this event is only supported by Internet Explorer 10 and 11.
CategoryTypeAttributeDescriptionBubblesCancelable
PointerpointerdownonpointerdownFires when the pointing device button is activated, or pressed over an element.
PointerpointeruponpointerupFires when the pointing device button is released over an element
PointerpointercancelonpointercancelFires when a pointing device is unlikely to continue to produce event because, for example, the device is used for panning/zooming after a pointerdown event.
PointerpointermoveonpointermoveFires when the pointing device is moved while it is over an element
PointerpointeroveronpointeroverFires when the pointing device is moved onto an element
PointerpointeroutonpointeroutFires when the pointing device is moved away from an element. Also fires after pointerup by pointing device without hovering, or after
PointerpointerenteronpointerenterFires when the pointing device is moved onto an element, or when the button of the pointing device which does not support hovering is pressed on one of its descendant elements.
PointerpointerleaveonpointerleaveFires when the pointing device is moved away from an element, or when the button of the pointing device which does not support hovering is released over its descendant elements.
PointergotpointercaptureongotpointercaptureFires when the pointer is captured by setPointerCapture method.
PointerlostpointercaptureonlostpointercaptureFires when the pointer is released by releasePointerCapture method.

Indie UI events

Not yet really implemented, the Indie UI working groups want to help web application developers to be able to support standard user interaction events without having to handle different platform specific technical events that could match with it.
Scripting usable interfaces can be difficult, especially when one considers that user interface design patterns differ across software platforms, hardware, and locales, and that those interactions can be further customized based on personal preference. Individuals are accustomed to the way the interface works on their own system, and their preferred interface frequently differs from that of the web application author's preferred interface.
For example, web application authors, wishing to intercept a user's intent to undo the last action, need to "listen" for all the following events:
  • Control+Z on Windows and Linux.
  • Command+Z on Mac OS X.
  • Shake events on some mobile devices.
It would be simpler to listen for a single, normalized request to "undo" the previous action.
CategoryTypeDescriptionBubblesCancelable
RequestundorequestIndicates the user desires to "undo" the previous action.
RequestredorequestIndicates the user desires to "redo" the previously "undone" action.
RequestexpandrequestIndicates the user desires to reveal information in a collapsed section or branch node in a hierarchy.
RequestcollapserequestIndicates the user desires to hide or collapse information in an expanded section or branch node in a hierarchy.
RequestdismissrequestIndicates the user desires "dismiss" the current view.
RequestdeleterequestIndicates the user wants to initiate a "delete" action on the marked element or current view.
Focus RequestdirectionalfocusrequestInitiated when the user agent sends a "direction focus" request to the web application. Web authors should not use or register for directionalfocusrequest events when standard browser focus and blur events are sufficient. Using these events unnecessarily could result in reduced performance or negative user experience.
Focus RequestlinearfocusrequestInitiated when the user agent sends a "linear focus" request to the web application. Web authors should not use or register for linearfocusrequest events when standard browser focus and blur events are sufficient. This event type is only necessary on specialized control types such as data grids where the logical next element may not be focusable or even in the DOM until requested. Using these events unnecessarily could result in reduced performance or negative user experience.
Focus RequestpalettefocusrequestInitiated when the user agent sends a "palette focus" request to the web application. Web app authors receiving this event should move focus to the first palette in the web application, or cycle focus between all available palettes. Note: palettes are sometimes referred to as non-modal dialogs or inspector windows.
Focus RequesttoolbarfocusrequestInitiated when the user agent sends a "toolbar focus" request to the web application. Web app authors receiving this event should move focus to the main toolbar in the web application, or cycle focus between all available toolbars.
Manipulation RequestmoverequestInitiated when the user agent sends a move request to the web application with accompanying x/y delta values. This is used, for example, when moving an object to a new location on a layout canvas.
Manipulation RequestpanrequestInitiated when the user agent sends a pan request to the web application with accompanying x/y delta values. This is used, for example, when changing the center point while panning a map or another custom image viewer.
Manipulation RequestrotationrequestInitiated when the user agent sends a rotation request to the web application with accompanying origin x/y values and a rotation value in degrees.
Manipulation RequestzoomrequestInitiated when the user agent sends a zoom request to the web application with accompanying origin x/y values and the zoom scale factor.
Scroll RequestscrollrequestInitiated when the user agent sends a scroll request to the web application with accompanying x/y delta values or one of the other defined scrollType values. Authors should only use this event and uiaction with custom scroll views.
ValueChange RequestvaluechangerequestInitiated when the user agent sends a value change request to the web application. Used on custom range controls like sliders, carousels, etc.

Internet Explorer-specific events

In addition to the common events, two major types of events are added by Internet Explorer. Some of the events have been implemented as de facto standards by other browsers.
CategoryTypeAttributeDescriptionBubblesCancelable
ClipboardcutoncutFires after a selection is cut to the clipboard.
ClipboardcopyoncopyFires after a selection is copied to the clipboard.
ClipboardpasteonpasteFires after a selection is pasted from the clipboard.
ClipboardbeforecutonbeforecutFires before a selection is cut to the clipboard.
ClipboardbeforecopyonbeforecopyFires before a selection is copied to the clipboard.
ClipboardbeforepasteonbeforepasteFires before a selection is pasted from the clipboard.
Data bindingafterupdateonafterupdateFires immediately after a databound object has been updated.
Data bindingbeforeupdateonbeforeupdateFires before a data source is updated.
Data bindingcellchangeoncellchangeFires when a data source has changed.
Data bindingdataavailableondataavailableFires when new data from a data source become available.
Data bindingdatasetchangedondatasetchangedFires when content at a data source has changed.
Data bindingdatasetcompleteondatasetcompleteFires when transfer of data from the data source has completed.
Data bindingerrorupdateonerrorupdateFires if an error occurs while updating a data field.
Data bindingrowenteronrowenterFires when a new row of data from the data source is available.
Data bindingrowexitonrowexitFires when a row of data from the data source has just finished.
Data bindingrowsdeleteonrowsdeleteFires when a row of data from the data source is deleted.
Data bindingrowinsertedonrowinsertedFires when a row of data from the data source is inserted.
MousecontextmenuoncontextmenuFires when the context menu is shown.
MousedragondragFires when during a mouse drag.
MousedragstartondragstartFires when a mouse drag begins.
MousedragenterondragenterFires when something is dragged onto an area.
MousedragoverondragoverFires when a drag is held over an area.
MousedragleaveondragleaveFires when something is dragged out of an area.
MousedragendondragendFires when a mouse drag ends.
MousedropondropFires when a mouse button is released over a valid target during a drag.
MouseselectstartonselectstartFires when the user starts to select text.
KeyboardhelponhelpFires when the user initiates help.
HTML frame/objectbeforeunloadonbeforeunloadFires before a document is unloaded.
HTML frame/objectstoponstopFires when the user stops loading the object.
HTML formbeforeeditfocusonbeforeeditfocusFires before an element gains focus for editing.
MarqueestartonstartFires when a marquee begins a new loop.
MarqueefinishonfinishFires when marquee looping is complete.
MarqueebounceonbounceFires when a scrolling marquee bounces back in the other direction.
MiscellaneousbeforeprintonbeforeprintFires before a document is printed
MiscellaneousafterprintonafterprintFires immediately after the document prints.
MiscellaneouspropertychangeonpropertychangeFires when the property of an object is changed.
MiscellaneousfilterchangeonfilterchangeFires when a filter changes properties or finishes a transition.
MiscellaneousreadystatechangeonreadystatechangeFires when the readyState property of an element changes.
MiscellaneouslosecaptureonlosecaptureFires when the releaseCapture method is invoked.

Note that Mozilla, Safari and Opera also support the readystatechange event for the XMLHttpRequest object. Mozilla also supports the beforeunload event using the traditional event registration method. Mozilla and Safari also support contextmenu, but Internet Explorer for Mac does not.
Note that Firefox 6 and later support the beforeprint and afterprint events.

XUL events

In addition to the common events, Mozilla defined a set of events that work only with XUL elements.
CategoryTypeAttributeDescriptionBubblesCancelable
MouseDOMMouseScrollDOMMouseScrollFires when the mouse wheel is moved, causing the content to scroll.
MousedragdropondragdropFires when the user releases the mouse button to drop an object being dragged.
MousedragenterondragenterFires when the mouse pointer first moves over an element during a drag. It is similar to the mouseover event but occurs while dragging.
MousedragexitondragexitFires when the mouse pointer moves away from an element during a drag. It is also called after a drop on an element. It is similar to the mouseout event but occurs during a drag.
MousedraggestureondraggestureFires when the user starts dragging the element, usually by holding down the mouse button and moving the mouse.
MousedragoverondragoverRelated to the mousemove event, this event is fired while something is being dragged over an element.
InputCheckboxStateChangeFires when a checkbox is checked or unchecked, either by the user or a script.
InputRadioStateChangeFires when a radio button is selected, either by the user or a script.
InputcloseoncloseFires when a request has been made to close the window.
InputcommandoncommandSimilar to W3C DOMActivate event. Fires when an element is activated, for instance, through a mouse click or a keypress.
InputinputoninputFires when a user enters text in a textbox.
User interfaceDOMMenuItemActiveDOMMenuItemActiveFires when a menu or menuitem is hovered over, or highlighted.
User interfaceDOMMenuItemInactiveDOMMenuItemInactiveFires when a menu or menuitem is no longer being hovered over, or highlighted.
User interfacecontextmenuoncontextmenuFires when the user requests to open the context menu for the element. The action to do this varies by platform, but it will typically be a right click.
User interfaceoverflowonoverflowFires a box or other layout element when there is not enough space to display it at full size.
User interfaceoverflowchangedonoverflowchangedFires when the overflow state changes.
User interfaceunderflowonunderflowFires to an element when there becomes enough space to display it at full size.
User interfacepopuphiddenonpopuphiddenFires to a popup after it has been hidden.
User interfacepopuphidingonpopuphidingFires to a popup when it is about to be hidden.
User interfacepopupshowingonpopupshowingFires to a popup just before it is popped open.
User interfacepopupshownonpopupshownFires to a popup after it has been opened, much like the onload event is sent to a window when it is opened.
CommandbroadcastonbroadcastPlaced on an observer. The broadcast event is sent when the attributes of the broadcaster being listened to are changed.
CommandcommandupdateoncommandupdateFires when a command update occurs.

Other events

For Mozilla and Opera 9, there are also undocumented events known as DOMContentLoaded and DOMFrameContentLoaded which fire when the DOM content is loaded. These are different from "load" as they fire before the loading of related files. However, DOMContentLoaded has been added to the HTML 5 specification.
The DOMContentLoaded event was also implemented in the Webkit rendering engine build 500+. This correlates to all versions of Google Chrome and Safari 3.1+. DOMContentLoaded is also implemented in Internet Explorer 9.
Opera 9 also supports the Web Forms 2.0 events DOMControlValueChanged, invalid, forminput and formchange.

Event flow

Consider the situation when two event targets participate in a . Both have event listeners registered on the same event type, say "click". When the user clicks on the inner element, there are two possible ways to handle it:
  • Trigger the elements from outer to inner. This model is implemented in Netscape Navigator.
  • Trigger the elements from inner to outer. This model is implemented in Internet Explorer and other browsers.
W3C takes a middle position in this struggle.
According to the W3C, events go through three phases when an event target participates in a tree:
  1. The capture phase: the event travels down from the root event target to the target of an event
  2. The target phase: the event travels through the event target
  3. The bubble phase : the event travels back up from the target of an event to the root event target. The bubble phase will only occur for events that bubble
You can find a visualization of this event flow at https://domevents.dev

Stopping events

While an event is travelling through event listeners, the event can be stopped with event.stopPropagation or event.stopImmediatePropagation, event.stopPropagation: the event is stopped after all event listeners attached to the current event target in the current event phase are finishedevent.stopImmediatePropagation: the event is stopped immediately and no further event listeners are executed
When an event is stopped it will no longer travel along the event path. Stopping an event does not cancel an event.

Legacy mechanisms to stop an event

  • Set the event.cancelBubble to true
  • Set the event.returnValue property to false

Canceling events

A cancelable event can be canceled by calling event.preventDefault. Canceling an event will opt out of the default browser behaviour for that event. When an event is canceled, the event.defaultPrevented property will be set to true. Canceling an event will not stop the event from traveling along the event path.

Event object

The Event object provides a lot of information about a particular event, including information about target element, key pressed, mouse button pressed, mouse position, etc. Unfortunately, there are very serious browser incompatibilities in this area. Hence only the W3C Event object is discussed in this article.
NameTypeDescription
typeDOMStringThe name of the event.
targetEventTargetUsed to indicate the EventTarget to which the event was originally dispatched.
currentTargetEventTargetUsed to indicate the EventTarget whose EventListeners are currently being processed.
eventPhaseunsigned shortUsed to indicate which phase of event flow is currently being evaluated.
bubblesbooleanUsed to indicate whether or not an event is a bubbling event.
cancelablebooleanUsed to indicate whether or not an event can have its default action prevented.
timeStampDOMTimeStampUsed to specify the time at which the event was created.

NameArgument typeArgument nameDescription
stopPropagationTo prevent further propagation of an event during event flow.
preventDefaultTo cancel the event if it is cancelable, meaning that any default action normally taken by the implementation as a result of the event will not occur.
initEventDOMStringeventTypeArgSpecifies the event type.
initEventbooleancanBubbleArgSpecifies whether or not the event can bubble.
initEventbooleancancelableArgSpecifies whether or not the event's default action can be prevented.

Event handling models

DOM Level 0

This event handling model was introduced by Netscape Navigator, and remains the most cross-browser model. There are two model types: the inline model and the traditional model.

Inline model

In the inline model, event handlers are added as attributes of elements. In the example below, an alert dialog box with the message "Hey Joe" appears after the hyperlink is clicked. The default click action is cancelled by returning false in the event handler.





Inline Event Handling


Inline Event Handling


Hey Joe!






One common misconception with the inline model is the belief that it allows the registration of event handlers with custom arguments, e.g. name in the triggerAlert function. While it may seem like that is the case in the example above, what is really happening is that the JavaScript engine of the browser creates an anonymous function containing the statements in the onclick attribute. The onclick handler of the element would be bound to the following anonymous function:

function

This limitation of the JavaScript event model is usually overcome by assigning attributes to the function object of the event handler or by using closures.

Traditional model

In the traditional model, event handlers can be added or removed by scripts. Like the inline model, each event can only have one event handler registered. The event is added by assigning the handler name to the event property of the element object. To remove an event handler, simply set the property to null:





Traditional Event Handling


Traditional Event Handling


Hey Joe!






To add parameters:

var name = 'Joe';
document.onclick = );

Inner functions preserve their scope.

DOM Level 2

The W3C designed a more flexible event handling model in DOM Level 2.
NameDescriptionArgument typeArgument name
addEventListenerAllows the registration of event listeners on the event target.DOMStringtype
addEventListenerAllows the registration of event listeners on the event target.EventListenerlistener
addEventListenerAllows the registration of event listeners on the event target.booleanuseCapture
removeEventListenerAllows the removal of event listeners from the event target.DOMStringtype
removeEventListenerAllows the removal of event listeners from the event target.EventListenerlistener
removeEventListenerAllows the removal of event listeners from the event target.booleanuseCapture
dispatchEventAllows sending the event to the subscribed event listeners.Eventevt

Some useful things to know :
  • To prevent an event from bubbling, developers must call the stopPropagation method of the event object.
  • To prevent the default action of the event to be called, developers must call the preventDefault method of the event object.
The main difference from the traditional model is that multiple event handlers can be registered for the same event. The useCapture option can also be used to specify that the handler should be called in the capture phase instead of the bubbling phase. This model is supported by Mozilla, Opera, Safari, Chrome and Konqueror.

A rewrite of the example used in the traditional model






DOM Level 2


DOM Level 2



Hey Joe!








Internet Explorer-specific model

Microsoft Internet Explorer prior to version 8 does not follow the W3C model, as its own model was created prior to the ratification of the W3C standard. Internet Explorer 9 follows DOM level 3 events, and Internet Explorer 11 deletes its support for Microsoft-specific model.
NameDescriptionArgument typeArgument name
attachEventSimilar to W3C's addEventListener method.StringsEvent
attachEventSimilar to W3C's addEventListener method.PointerfpNotify
detachEventSimilar to W3C's removeEventListener method.StringsEvent
detachEventSimilar to W3C's removeEventListener method.PointerfpNotify
fireEventSimilar to W3C's dispatchEvent method.StringsEvent
fireEventSimilar to W3C's dispatchEvent method.EventoEventObject

Some useful things to know :
  • To prevent an event bubbling, developers must set the event's cancelBubble property.
  • To prevent the default action of the event to be called, developers must set the event's returnValue property.
  • The this keyword refers to the global window object.
Again, this model differs from the traditional model in that multiple event handlers can be registered for the same event. However the useCapture option can not be used to specify that the handler should be called in the capture phase. This model is supported by Microsoft Internet Explorer and Trident based browsers.

A rewrite of the example used in the old Internet Explorer-specific model






Internet Explorer-specific model


Internet Explorer-specific model


Hey Joe!