The UIEvent
interface represents simple user interface events.
UIEvent
derives from Event
. Although the UIEvent.initUIEvent()
method is kept for backward compatibility, you should create a UIEvent
object using the UIEvent()
constructor.
Several interfaces are direct or indirect descendants of this one: MouseEvent
, TouchEvent
, FocusEvent
, KeyboardEvent
, WheelEvent
, InputEvent
, and CompositionEvent
.
<div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/Event" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Event</text></a><polyline points="76,25 86,20 86,30 76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/UIEvent" target="_top"><rect x="116" y="1" width="75" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="153.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">UIEvent</text></a></svg></div>
a:hover text { fill: #0095DD; pointer-events: all;}
Constructors
UIEvent()
- Creates a
UIEvent
object.
Properties
This interface also inherits properties of its parent, Event
.
UIEvent.cancelBubble
' '- Is a
Boolean
indicating whether the bubbling of the event has been canceled or not.
UIEvent.detail
Read only- Returns a
long
with details about the event, depending on the event type. UIEvent.isChar
' Read only- Returns a
Boolean
indicating whether the event produced a key character or not. UIEvent.layerX
' Read only- Returns the horizontal coordinate of the event relative to the current layer.
UIEvent.layerY
' Read only- Returns the vertical coordinate of the event relative to the current layer.
UIEvent.pageX
' Read only- Returns the horizontal coordinate of the event relative to the whole document.
UIEvent.pageY
' Read only- Returns the vertical coordinate of the event relative to the whole document.
UIEvent.sourceCapabilities
' Read only- Returns an instance of the
InputDeviceCapabilities
interface, which provides information about the physical device responsible for generating a touch event. UIEvent.view
Read only- Returns a
WindowProxy
that contains the view that generated the event. UIEvent.which
' Read only- Returns the numeric
keyCode
of the key pressed, or the character code (charCode
) for an alphanumeric key pressed.
Methods
This interface also inherits methods of its parent, Event
.
UIEvent.initUIEvent()
'- Initializes a
UIEvent
object. If the event has already being dispatched, this method does nothing.
Specifications
Specification | Status | Comment |
InputDeviceCapabilities | Draft | Added sourceCapabilities property.
|
UI Events | Working Draft | Extend DOM3 |
Document Object Model (DOM) Level 3 Events SpecificationThe definition of 'UIEvent' in that specification. | Obsolete | Added the UIEvent() constructor, deprecated the initUIEvent() method and changed the type of view from AbstractView to WindowProxy .
|
Document Object Model (DOM) Level 2 Events SpecificationThe definition of 'UIEvent' in that specification. | Obsolete | Initial definition |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
UIEvent
|
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support Yes |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
UIEvent() constructor
|
Chrome
Full support Yes |
Edge
Full support ≤18 |
Firefox
Full support 11 |
IE
? |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support 14 |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes |
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support Yes |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes | |
detail
|
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE Partial support 9 Partial support 9 Notes' Always |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
? |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support Yes | |
Chrome
No support No |
Edge
No support No |
Firefox No support ? — 55 No support ? — 55 Notes' The |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android No support ? — 55 No support ? — 55 Notes' The |
Opera Android
No support No |
Safari iOS
No support No |
Samsung Internet Android
No support No | |
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support 9 |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes | |
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support 9 |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes | |
Chrome No support ? — 44 No support ? — 44 Notes' Replaced by |
Edge
Full support 12 |
Firefox
? |
IE
Full support 9 |
Opera
? |
Safari
? |
WebView Android No support ? — 44 No support ? — 44 Notes' Replaced by |
Chrome Android No support ? — 44 No support ? — 44 Notes' Replaced by |
Firefox Android
? |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android No support ? — 4.0 No support ? — 4.0 Notes' Replaced by | |
Chrome No support ? — 44 No support ? — 44 Notes' Replaced by |
Edge
Full support 12 |
Firefox
? |
IE
Full support 9 |
Opera
? |
Safari
? |
WebView Android No support ? — 44 No support ? — 44 Notes' Replaced by |
Chrome Android No support ? — 44 No support ? — 44 Notes' Replaced by |
Firefox Android
? |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android No support ? — 4.0 No support ? — 4.0 Notes' Replaced by | |
Chrome
Full support 47 |
Edge
Full support ≤79 |
Firefox
? |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support 47 |
Chrome Android
Full support 47 |
Firefox Android
? |
Opera Android
Full support Yes |
Safari iOS
? |
Samsung Internet Android
Full support 5.0 | |
view
|
Chrome
Full support Yes |
Edge
Full support 12 |
Firefox
Full support Yes |
IE
Full support 9 |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
which
|
Chrome
Full support Yes |
Edge
Full support ≤79 |
Firefox
Full support Yes |
IE
No support No |
Opera
Full support Yes |
Safari
Full support Yes |
WebView Android
Full support Yes |
Chrome Android
Full support Yes |
Firefox Android
Full support Yes |
Opera Android
Full support Yes |
Safari iOS
Full support Yes |
Samsung Internet Android
Full support Yes |
Legend
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
- Non-standard. Expect poor cross-browser support.'
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.'
- Deprecated. Not for use in new websites.
- See implementation notes.'
- See implementation notes.
See also
- [[../../../Learn/JavaScript/Building_blocks/Events|Introduction to events]]
Event
UIEvent by Mozilla Contributors is licensed under CC-BY-SA 2.5.