TouchEvent: TouchEvent() constructor
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
TheTouchEvent()
constructor creates a newTouchEvent
object.
Note:If you construct a synthetic event using this constructor, that event will not betrusted, for security reasons.Only browser-generatedTouchEvent
objects are trusted and only trusted events trigger default actions.
Syntax
new TouchEvent(type)new TouchEvent(type, options)
Parameters
type
A string with the name of the event.It is case-sensitive and browsers set it to
touchstart
,touchend
,touchmove
,touchcancel
options
OptionalAn object that,in addition of the properties defined in
UIEvent()
, can have the following properties:touches
OptionalA
TouchList
, defaulting to an empty one, that is a list of objects for every point of contact currently touching the surface.targetTouches
OptionalA
TouchList
, defaulting to an empty one, that is a list of objects for every point of contact that is touching the surfaceand started on the element that is the target of the current event.changedTouches
Optionaland defaulting to
[]
, of typeTouch[]
, that is a list of objects for every point of contact which contributed to the event.ctrlKey
OptionalA boolean value, defaulting to
false
, indicating if thectrl key was simultaneously pressed.shiftKey
OptionalA boolean value, defaulting to
false
, indicating if theshift key was simultaneously pressed.altKey
OptionalA boolean value, defaulting to
false
, indicating if thealt key was simultaneously pressed.metaKey
OptionalA boolean value, defaulting to
false
, indicating if themeta key was simultaneously pressed.
Return value
A newTouchEvent
object.
Specifications
Specification |
---|
Touch Events # dom-touchevent-constructor |
Browser compatibility
See also
TouchEvent
, the interface of the objects it constructs.