TouchEvent

  • Revision slug: DOM/TouchEvent
  • Revision title: TouchEvent
  • Revision id: 77685
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment 36 words added

Revision Content

{{ domref() }}

A TouchEvent represents an event sent when the state of contacts with a touch-sensitive surface changes. This surface can be a touch screen or trackpad, for example. The event can describe one or more points of contact with the screen and includes support for detecting movement, addition and removal of contact points, and so forth.

Touches are represented by the {{ domxref("Touch") }} object; each touch is described by a position, size and shape, amount of pressure, and target element. Lists of touches are represented by {{ domxref("TouchList") }} objects.

Attributes

{{ domxref("event.altKey", "TouchEvent.altKey") }}
A Boolean value indicating whether or not the alt key was down when the touch event was fired. Read only.
{{ domxref("TouchEvent.changedTouches") }}
A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects representing individual points of contact whose states changed between the previous touch event and this one. Read only.
{{ domxref("event.ctrlKey", "TouchEvent.ctrlKey") }}
A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.
{{ domxref("event.metaKey", "TouchEvent.metaKey") }}
A Boolean value indicating whether or not the meta key was down when the touch event was fired. Read only.
{{ domxref("event.shiftKey", "TouchEvent.shiftKey") }}
A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.
{{ domxref("TouchEvent.targetTouches") }}
A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects that are both currently in contact with the touch surface and were also started on the same element that is the target of the event. Read only.
{{ domxref("TouchEvent.touches") }}
A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects representing all current points of contact with the surface, regardless of target or changed status. Read only.
{{ domxref("event.type", "TouchEvent.type") }}
The type of touch event that occurred. See {{ anch("Touch event types") }} for possible values and details.

Touch event types

There are several types of event that can be fired to indicate that touch-related changes have occurred. You can determine which of these has happened by looking at the event's {{domxref("event.type", "TouchEvent.type") property.

Note: It's important to note that in many cases, both touch and mouse events get sent (in order to let non-touch-specific code still interact with the user). If you use touch events, you should call {{ domxref("event.preventDefault()") }} to keep the mouse event from being sent as well.

touchstart

Sent when the user places a touch point on the touch surface. The event's target will be the {{ domxref("element") }} in which the touch occurred.

touchend

Sent when the user removes a touch point from the surface (that is, when they lift a finger or stylus from the surface). This is also sent if the touch point moves off the edge of the surface; for example, if the user's finger slides off the edge of the screen.

The event's target is the same {{ domxref("element") }} that received the touchstart event corresponding to the touch point, even if the touch point has moved outside that element.

The touch point (or points) that were removed from the surface can be found in the {{ domxref("TouchList") }} specified by the changedTouches attribute.

touchmove

Sent when the user moves a touch point along the surface. The event's target is the same {{ domxref("element") }} that received the touchstart event corresponding to the touch point, even if the touch point has moved outside that element.

This event is also sent if the values of the radius, rotation angle, or force attributes of a touch point change.

Note: The rate at which touchmove events is sent is browser-specific, and may also vary depending on the capability of the user's hardware. You must not rely on a specific granularity of these events.

touchenter

Sent when a touch point enters an {{ domxref("element") }}.

Note: These events don't bubble.

touchleave

Sent when a touch point exits an {{ domxref("element") }}.

Note: These events don't bubble.

touchcancel

Sent when a touch point has been disrupted in some way. There are several possible reasons why this might happen (and the exact reasons will vary from device to device, as well as browser to browser):

  • An event of some kind occurred that canceled the touch; this might happen if a modal alert pops up during the interaction.
  • The touch point has left the document window and moved into the browser's UI area, a plug-in, or other external content.
  • The user has placed more touch points on the screen than can be supported, in which case the earliest {{ domxref("Touch") }} in the {{ domxref("TouchList") }} gets canceled.

Revision Source

<p>{{ domref() }}</p>
<p>A <code>TouchEvent</code> represents an event sent when the state of contacts with a touch-sensitive surface changes. This surface can be a touch screen or trackpad, for example. The event can describe one or more points of contact with the screen and includes support for detecting movement, addition and removal of contact points, and so forth.</p>
<p>Touches are represented by the {{ domxref("Touch") }} object; each touch is described by a position, size and shape, amount of pressure, and target element. Lists of touches are represented by {{ domxref("TouchList") }} objects.</p>
<h2>Attributes</h2>
<dl> <dl> <dt>{{ domxref("event.altKey", "TouchEvent.altKey") }}</dt> <dd>A Boolean value indicating whether or not the alt key was down when the touch event was fired. <strong>Read only.</strong></dd> <dt>{{ domxref("TouchEvent.changedTouches") }}</dt> <dd>A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects representing individual points of contact whose states changed between the previous touch event and this one. <strong>Read only.</strong></dd> <dt>{{ domxref("event.ctrlKey", "TouchEvent.ctrlKey") }}</dt> <dd>A Boolean value indicating whether or not the control key was down when the touch event was fired. <strong>Read only.</strong></dd> <dt>{{ domxref("event.metaKey", "TouchEvent.metaKey") }}</dt> <dd>A Boolean value indicating whether or not the meta key was down when the touch event was fired. <strong>Read only.</strong></dd> <dt>{{ domxref("event.shiftKey", "TouchEvent.shiftKey") }}</dt> <dd>A Boolean value indicating whether or not the shift key was down when the touch event was fired. <strong>Read only.</strong></dd> <dt>{{ domxref("TouchEvent.targetTouches") }}</dt> <dd>A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects that are both currently in contact with the touch surface <strong>and</strong> were also started on the same element that is the target of the event. <strong>Read only.</strong></dd> <dt>{{ domxref("TouchEvent.touches") }}</dt> <dd>A {{ domxref("TouchList") }} of all the {{ domxref("Touch") }} objects representing all current points of contact with the surface, regardless of target or changed status. <strong>Read only.</strong></dd> <dt><strong>{{ domxref("event.type", "TouchEvent.type") }}</strong></dt> <dd>The type of touch event that occurred. See {{ anch("Touch event types") }} for possible values and details.</dd> </dl><h2>Touch event types</h2>
<p>There are several types of event that can be fired to indicate that touch-related changes have occurred. You can determine which of these has happened by looking at the event's {{domxref("event.type", "TouchEvent.type") property.</p>
<div class="note"><strong>Note:</strong> It's important to note that in many cases, both touch and mouse events get sent (in order to let non-touch-specific code still interact with the user). If you use touch events, you should call {{ domxref("event.preventDefault()") }} to keep the mouse event from being sent as well.</div>
<h3>touchstart</h3>
<p>Sent when the user places a touch point on the touch surface. The event's target will be the {{ domxref("element") }} in which the touch occurred.</p>
<h3>touchend</h3>
<p>Sent when the user removes a touch point from the surface (that is, when they lift a finger or stylus from the surface). This is also sent if the touch point moves off the edge of the surface; for example, if the user's finger slides off the edge of the screen.</p>
<p>The event's target is the same {{ domxref("element") }} that received the <code>touchstart</code> event corresponding to the touch point, even if the touch point has moved outside that element.</p>
<p>The touch point (or points) that were removed from the surface can be found in the {{ domxref("TouchList") }} specified by the <code>changedTouches</code> attribute.</p>
<h3>touchmove</h3>
<p>Sent when the user moves a touch point along the surface. The event's target is the same {{ domxref("element") }} that received the <code>touchstart</code> event corresponding to the touch point, even if the touch point has moved outside that element.</p>
<p>This event is also sent if the values of the radius, rotation angle, or force attributes of a touch point change.</p>
<div class="note"><strong>Note:</strong> The rate at which <code>touchmove</code> events is sent is browser-specific, and may also vary depending on the capability of the user's hardware. You must not rely on a specific granularity of these events.</div>
<h3>touchenter</h3>
<p>Sent when a touch point enters an {{ domxref("element") }}.</p>
<div class="note"><strong>Note:</strong> These events don't bubble.</div>
<h3>touchleave</h3>
<p>Sent when a touch point exits an {{ domxref("element") }}.</p>
<div class="note"><strong>Note:</strong> These events don't bubble.</div>
<h3>touchcancel</h3>
<p>Sent when a touch point has been disrupted in some way. There are several possible reasons why this might happen (and the exact reasons will vary from device to device, as well as browser to browser):</p>
<ul> <li>An event of some kind occurred that canceled the touch; this might happen if a modal alert pops up during the interaction.</li> <li>The touch point has left the document window and moved into the browser's UI area, a plug-in, or other external content.</li> <li>The user has placed more touch points on the screen than can be supported, in which case the earliest {{ domxref("Touch") }} in the {{ domxref("TouchList") }} gets canceled.</li>
</ul>
<dl></dl></dl>
Revert to this revision