From af9d6e9b0551f735382ce6576b33e29a86329fa3 Mon Sep 17 00:00:00 2001 From: Okke Formsma Date: Sat, 6 Feb 2021 21:47:21 +0100 Subject: style(hold-tap)!: Write hold-tap params with dashes tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated. --- docs/docs/behaviors/hold-tap.md | 12 ++++++------ docs/docs/behaviors/mod-tap.md | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md index c148fa3..1326114 100644 --- a/docs/docs/behaviors/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md @@ -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 diff --git a/docs/docs/behaviors/mod-tap.md b/docs/docs/behaviors/mod-tap.md index 6404a22..bd08a38 100644 --- a/docs/docs/behaviors/mod-tap.md +++ b/docs/docs/behaviors/mod-tap.md @@ -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. -- cgit v1.2.3