Skip to main content

TouchEvent

The TouchEvent interface represents an UIEvent which is 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.

MDN Reference

Extends​

Methods​

composedPath()​

composedPath(): EventTarget[];

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

MDN Reference

Returns​

EventTarget[]

Inherited from​

UIEvent.composedPath

initEvent()​

initEvent(
   type, 
   bubbles?, 
   cancelable?
): void;

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

Parameters​

ParameterType
typestring
bubbles?boolean
cancelable?boolean

Returns​

void

Deprecated​

MDN Reference

Inherited from​

UIEvent.initEvent

initUIEvent()​

initUIEvent(
   typeArg, 
   bubblesArg?, 
   cancelableArg?, 
   viewArg?, 
   detailArg?
): void;

The UIEvent.initUIEvent() method initializes a UI event once it's been created.

Parameters​

ParameterType
typeArgstring
bubblesArg?boolean
cancelableArg?boolean
viewArg?Window | null
detailArg?number

Returns​

void

Deprecated​

MDN Reference

Inherited from​

UIEvent.initUIEvent

preventDefault()​

preventDefault(): void;

The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

MDN Reference

Returns​

void

Inherited from​

UIEvent.preventDefault

stopImmediatePropagation()​

stopImmediatePropagation(): void;

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

MDN Reference

Returns​

void

Inherited from​

UIEvent.stopImmediatePropagation

stopPropagation()​

stopPropagation(): void;

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

MDN Reference

Returns​

void

Inherited from​

UIEvent.stopPropagation

Properties​

altKey​

readonly altKey: boolean;

The read-only altKey property of the TouchEvent interface returns a boolean value indicating whether or not the alt (Alternate) key is enabled when the touch event is created. If the alt key is enabled, the attribute's value is true. Otherwise, it is false.

MDN Reference

AT_TARGET​

readonly AT_TARGET: 2;

Inherited from​

UIEvent.AT_TARGET

bubbles​

readonly bubbles: boolean;

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

Inherited from​

UIEvent.bubbles

BUBBLING_PHASE​

readonly BUBBLING_PHASE: 3;

Inherited from​

UIEvent.BUBBLING_PHASE

cancelable​

readonly cancelable: boolean;

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

Inherited from​

UIEvent.cancelable

cancelBubble​

cancelBubble: boolean;

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

Deprecated​

MDN Reference

Inherited from​

UIEvent.cancelBubble

CAPTURING_PHASE​

readonly CAPTURING_PHASE: 1;

Inherited from​

UIEvent.CAPTURING_PHASE

changedTouches​

readonly changedTouches: TouchList;

The changedTouches read-only property is a TouchList whose touch points (Touch objects) varies depending on the event type, as follows:

MDN Reference

composed​

readonly composed: boolean;

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

Inherited from​

UIEvent.composed

ctrlKey​

readonly ctrlKey: boolean;

The read-only ctrlKey property of the TouchEvent interface returns a boolean value indicating whether the control (Control) key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

MDN Reference

currentTarget​

readonly currentTarget: EventTarget | null;

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

Inherited from​

UIEvent.currentTarget

defaultPrevented​

readonly defaultPrevented: boolean;

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

Inherited from​

UIEvent.defaultPrevented

detail​

readonly detail: number;

The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.

MDN Reference

Inherited from​

UIEvent.detail

eventPhase​

readonly eventPhase: number;

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

MDN Reference

Inherited from​

UIEvent.eventPhase

isTrusted​

readonly isTrusted: boolean;

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

Inherited from​

UIEvent.isTrusted

metaKey​

readonly metaKey: boolean;

The read-only metaKey property of the TouchEvent interface returns a boolean value indicating whether or not the Meta key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

MDN Reference

NONE​

readonly NONE: 0;

Inherited from​

UIEvent.NONE

returnValue​

returnValue: boolean;

The Event property returnValue indicates whether the default action for this event has been prevented or not.

Deprecated​

MDN Reference

Inherited from​

UIEvent.returnValue

shiftKey​

readonly shiftKey: boolean;

The read-only shiftKey property of the TouchEvent interface returns a boolean value indicating whether or not the shift key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

MDN Reference

srcElement​

readonly srcElement: EventTarget | null;

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

Deprecated​

MDN Reference

Inherited from​

UIEvent.srcElement

target​

readonly target: EventTarget | null;

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

MDN Reference

Inherited from​

UIEvent.target

targetTouches​

readonly targetTouches: TouchList;

The targetTouches read-only property is a TouchList listing all the Touch objects for touch points that are still in contact with the touch surface and whose touchstart event occurred inside the same target element as the current target element.

MDN Reference

timeStamp​

readonly timeStamp: number;

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

Inherited from​

UIEvent.timeStamp

touches​

readonly touches: TouchList;

touches is a read-only TouchList listing all the Touch objects for touch points that are currently in contact with the touch surface, regardless of whether or not they've changed or what their target element was at touchstart time.

MDN Reference

type​

readonly type: string;

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

MDN Reference

Inherited from​

UIEvent.type

view​

readonly view: Window | null;

The UIEvent.view read-only property returns the WindowProxy object from which the event was generated. In browsers, this is the Window object the event happened in.

MDN Reference

Inherited from​

UIEvent.view

which​

readonly which: number;

The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.

Deprecated​

MDN Reference

Inherited from​

UIEvent.which