ARK-OS/arkos/arkrt/libinput/doc/user/tapping.rst

.. _tapping:

==============================================================================
Tap-to-click behaviour
==============================================================================

"Tapping" or "tap-to-click" is the name given to the behavior where a short
finger touch down/up sequence maps into a button click. This is most
commonly used on touchpads, but may be available on other devices.

libinput implements tapping for one, two, and three fingers, where supported by
the hardware, and maps those taps into a left, right, and middle button click,
respectively. This mapping can be switched to left, middle and right through
configuration. Not all devices support three fingers, libinput will support
tapping up to whatever is supported by the hardware. libinput does not support
four-finger taps or any tapping with more than four fingers, even though some
hardware can distinguish between that many fingers.

.. _tapping_default:

------------------------------------------------------------------------------
Tap-to-click default setting
------------------------------------------------------------------------------

Tapping is **disabled** by default on most devices, see
:commit:`2219c12c3` because:

- if you don't know that tapping is a thing (or enabled by default), you get
  spurious button events that make the desktop feel buggy.
- if you do know what tapping is and you want it, you usually know where to
  enable it, or at least you can search for it.

Tapping is **enabled** by default on devices where tapping is the only
method to trigger button clicks. This includes devices without physical
buttons such as touch-capable graphics tablets.

.. note:: Unfortunately due to the current API design, devices that require
          tapping effectively prevent us from changing this default. For details see
          `this comment <https://gitlab.freedesktop.org/libinput/libinput/-/issues/926#note_2056476>`_.

Tapping can be enabled/disabled on a per-device basis. See
**libinput_device_config_tap_set_enabled()** for details.

.. _tapndrag:

------------------------------------------------------------------------------
Tap-and-drag
------------------------------------------------------------------------------

libinput also supports "tap-and-drag" where a tap immediately followed by a
finger down and that finger being held down emulates a button press. Moving
the finger around can thus drag the selected item on the screen.
Tap-and-drag is optional and can be enabled or disabled with
**libinput_device_config_tap_set_drag_enabled()**. Most devices have
tap-and-drag enabled by default.

.. note:: Dragging is always done with one finger. The number of fingers on
          the initial tap decide the type of button click. For example, to
          middle-click drag, tap with three fingers followed by a
          single-finger drag.

Also optional is a feature called "drag lock". With drag lock **disabled**,
lifting the finger will stop any drag process. When **enabled**, the drag
process continues even after lifting a finger, allowing the user to
reset the finger position and keep moving without releasing the drag.

libinput supports two variations of this drag lock: "sticky"  and "timeout".
In sticky mode, the drag lock must be ended with an explicit additional tap.
In timeout mode, the drag lock ends automatically if no finger was put back on
the touchpad within a timeout.  Drag lock can be enabled and disabled with
**libinput_device_config_tap_set_drag_lock_enabled()**.
Note that drag lock only applies if tap-and-drag is enabled.

.. figure:: tap-n-drag.svg
    :align: center

    Tap-and-drag process

The above diagram explains the process, a tap (a) followed by a finger held
down (b) starts the drag process and logically holds the left mouse button
down. A movement of the finger (c) will drag the selected item until the
finger is released (e). If needed and drag lock is enabled, the finger's
position can be reset by lifting and quickly setting it down again on the
touchpad (d). This will be interpreted as continuing move and is especially
useful on small touchpads or with slow pointer acceleration.
If drag lock is enabled, the release of the mouse buttons after the finger
release (e) is triggered by a timeout (if in timeout mode) or by tapping again (f).

libinput also supports an "auto drag-lock" feature: if drag lock is **disabled**
but the dragging finger is released at the very edge of the touchpad,
a drag lock automatically activates for a short timeout. This allows a user to
quickly reset the finger to elsewhere on the touchpad and continue the dragging
motion. If the finger is released elsewhere, no drag lock activates.

If two fingers are supported by the hardware, a second finger can be used to
drag while the first is held in-place.

.. _tap_constraints:

------------------------------------------------------------------------------
Constraints while tapping
------------------------------------------------------------------------------

A couple of constraints apply to the contact to be converted into a press, the most common ones are:

- the touch down and touch up must happen within an implementation-defined timeout
- if a finger moves more than an implementation-defined distance while in contact, it's not a tap
- tapping within :ref:`clickpad software buttons <clickpad_softbuttons>` may not trigger an event
- a tap not meeting required pressure thresholds can be ignored as accidental touch
- a tap exceeding certain pressure thresholds can be ignored (see :ref:`palm_detection`)
- a tap on the edges of the touchpad can usually be ignored (see :ref:`palm_detection`)