Skip to content

UIControl: touchdraginside event ​

The touchdraginside event fires when a finger held down moves within the control's bounds.

Syntax ​

addEventListener('touchdraginside', (event) => { })

Event object ​

The event object's type is UIControlTouchEvent. Besides type and target, it carries two read-only fields:

FieldTypeMeaning
locationCGPoint or nullThe finger's position, in this control's own coordinate system, in pt. null when fired by sendActionsForControlEvents()
tapCountnumberThe number of consecutive taps, counted in taps. 0 when fired by sendActionsForControlEvents()

The callback parameter is declared as Event; to read these two fields, cast it to UIControlTouchEvent, as shown in the example.

It cannot be canceled: cancelable is false, and preventDefault() has no effect.

When it fires ​

  • Fires once per movement of the finger inside the control, continuously while it moves (measured).
  • Fired by all controls.

Event sequence of a touch ​

A plain tap (press, no movement, release), measured on a UIControl created directly:

touchdown → touchupinside

Pressing, sliding out, then releasing: the first four steps are measured; the last step, touchupoutside, is not verified in the simulator:

touchdown
→ touchdraginside (fires once per finger movement inside)
→ touchdragexit (once)
→ touchdragoutside (fires once per finger movement outside)
→ touchupoutside

Sliding out, sliding back in, then releasing: after touchdragoutside come touchdragenter and touchdraginside, and finally touchupinside. Not verified in the simulator.

Examples ​

js
const card = new UIControl();
card.addEventListener('touchdraginside', (e) => {
  const { location } = /** @type {UIControlTouchEvent} */ (e);
  if (location !== null) {
    console.log(location.x, location.y);
  }
});

Effect: While a finger held down moves within card, the console keeps printing the finger's coordinates.

Corresponding iOS API ​

UIControlEventTouchDragInside. Natively it is registered with addTarget:action:forControlEvents:; here, use addEventListener().

See also ​