summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOkke Formsma <okke@formsma.nl>2021-01-31 21:37:57 +0100
committerPete Johanson <peter@peterjohanson.com>2021-02-02 15:28:16 -0500
commit9a7908b6324181403836908e90754146fb7f0b5b (patch)
tree59821b1f4b4821e559246c0fc72a582b43769624 /docs
parent6c7ab0ce53ec75394eaa84ae303d725300cb1f45 (diff)
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat. After a tap, if the same key is pressed within `quick_tap_ms`, the tap behavior is always picked. This is useful for things like `&ht LSHFT BACKSPACE` where holding the backspace is required. Implements #288.
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/behaviors/hold-tap.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md
index 0cf4888..c148fa3 100644
--- a/docs/docs/behaviors/hold-tap.md
+++ b/docs/docs/behaviors/hold-tap.md
@@ -11,7 +11,7 @@ Simply put, the hold-tap key will output the 'hold' behavior if it's held for a
### Hold-Tap
-The `tapping_term_ms` parameter decides between a 'tap' and a 'hold'.
+The graph below shows how the hold-tap decides between a 'tap' and a 'hold'.
![Simple behavior](../assets/hold-tap/case1_2.png)
@@ -37,6 +37,18 @@ For basic usage, please see [mod-tap](./mod-tap.md) and [layer-tap](./layers.md)
### Advanced Configuration
+#### `tapping_term_ms`
+
+Defines how long a key must be pressed to trigger Hold behavior.
+
+#### `quick_tap_ms`
+
+If you press a tapped hold-tap again within `quick_tap_ms` milliseconds, it will always trigger the tap behavior. This is useful for things like a backspace, where a quick tap+hold holds backspace pressed. Set this to a negative value to disable. The default is -1 (disabled).
+
+In QMK, unlike ZMK, this functionality is enabled by default, and you turn it off using `TAPPING_FORCE_HOLD`.
+
+#### Home row mods
+
This example configures a hold-tap that works well for homerow mods:
```
@@ -50,6 +62,7 @@ This example configures a hold-tap that works well for homerow mods:
label = "HOMEROW_MODS";
#binding-cells = <2>;
tapping_term_ms = <150>;
+ quick_tap_ms = <0>;
flavor = "tap-preferred";
bindings = <&kp>, <&kp>;
};