Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

style(hold-tap)!: Write hold-tap params with dashes

Browse Source 
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms

The old style works, although it's deprecated.
This commit is contained in:
Okke Formsma
2021-02-06 21:47:21 +01:00
committed by Pete Johanson
parent 2af794eed3
commit af9d6e9b05
12 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/behaviors/hold-tap.md
View File

@@ -23,9 +23,9 @@ We call this the 'hold-preferred' flavor of hold-taps. While this flavor may wor
#### Flavors
- The 'hold-preferred' flavor triggers the hold behavior when the `tapping_term_ms` has expired or another key is pressed.
- The 'balanced' flavor will trigger the hold behavior when the `tapping_term_ms` has expired or another key is pressed and released.
- The 'tap-preferred' flavor triggers the hold behavior when the `tapping_term_ms` has expired. It triggers the tap behavior when another key is pressed.
- The 'hold-preferred' flavor triggers the hold behavior when the `tapping-term-ms` has expired or another key is pressed.
- The 'balanced' flavor will trigger the hold behavior when the `tapping-term-ms` has expired or another key is pressed and released.
- The 'tap-preferred' flavor triggers the hold behavior when the `tapping-term-ms` has expired. It triggers the tap behavior when another key is pressed.
When the hold-tap key is released and the hold behavior has not been triggered, the tap behavior will trigger.
@@ -37,7 +37,7 @@ For basic usage, please see [mod-tap](./mod-tap.md) and [layer-tap](./layers.md)
### Advanced Configuration
#### `tapping_term_ms`
#### `tapping-term-ms`
Defines how long a key must be pressed to trigger Hold behavior.
@@ -61,7 +61,7 @@ This example configures a hold-tap that works well for homerow mods:
compatible = "zmk,behavior-hold-tap";
label = "HOMEROW_MODS";
#binding-cells = <2>;
tapping_term_ms = <150>;
tapping-term-ms = <150>;
quick_tap_ms = <0>;
flavor = "tap-preferred";
bindings = <&kp>, <&kp>;
@@ -81,7 +81,7 @@ This example configures a hold-tap that works well for homerow mods:
```
If this config does not work for you, try the flavor "balanced" with a medium `tapping_term_ms` such as 200ms.
If this config does not work for you, try the flavor "balanced" with a medium `tapping-term-ms` such as 200ms.
#### Comparison to QMK

4
docs/docs/behaviors/mod-tap.md
View File

@@ -34,7 +34,7 @@ You can configure a different tapping term in your keymap:
```
&mt {
tapping_term_ms = <400>;
tapping-term-ms = <400>;
};
/ {
@@ -46,4 +46,4 @@ You can configure a different tapping term in your keymap:
### Additional information
The mod-tap is a [hold-tap](./hold-tap.md) under the hood with the "balanced" flavor and tapping_term_ms 200.
The mod-tap is a [hold-tap](./hold-tap.md) under the hood with the "balanced" flavor and tapping-term-ms 200.