From 414be93cb493dd0b92df42d1dd4a6cf352b4a599 Mon Sep 17 00:00:00 2001 From: Kurtis Lew Date: Fri, 10 Feb 2023 20:19:22 -0800 Subject: [PATCH] breaking change!!!(docs/hold-tap): Restructure flavors section --- docs/docs/behaviors/hold-tap.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/docs/behaviors/hold-tap.md b/docs/docs/behaviors/hold-tap.md index 81f3d490..39142f20 100644 --- a/docs/docs/behaviors/hold-tap.md +++ b/docs/docs/behaviors/hold-tap.md @@ -13,20 +13,10 @@ Hold-tap is the basis for other behaviors such as layer-tap and mod-tap. Simply put, the hold-tap key will output the 'hold' behavior if it's held for a while, and output the 'tap' behavior when it's tapped quickly. -### Hold-Tap - -The figures below shows how the hold-tap decides between a 'tap' and a 'hold'. - - - -By default, the hold-tap is configured to also select the 'hold' functionality if another key is tapped while it's active: - - - -We call this the 'hold-preferred' flavor of hold-taps. While this flavor may work very well for a ctrl/escape key, it's not very well suited for home-row mods or layer-taps. That's why there are two more flavors to choose from: 'tap-preferred' and 'balanced'. - ### Flavors +The 'flavor' of a hold-tap determines its behavior when it is tapped, held, and when another key is pressed while the hold-tap is undecided. For example, the [mod-tap](mod-tap.md) is a 'hold-preferred' hold-tap, while the [layer-tap](layers.md/#layer-tap) is of the 'tap-preferred' variety. + The 'hold-preferred' flavor triggers the hold behavior when the `tapping-term-ms` has expired or another key is pressed. > When the hold-tap key is released and the hold behavior has not been triggered, the tap behavior will trigger. -As shown previously, the hold-tap decision is generally made after the [`tapping-term-ms`](#tapping-term-ms) has expired. +The simplest flavor, 'hold-preferred', means that when the 'hold-tap' is held for longer than [`tapping-term-ms`](#tapping-term-ms), then it is considered a 'hold'. Otherwise, it is considered a tap. We show this in the diagram below. -Alternatively, the 'hold-preferred' flavor triggers the hold behavior when another key is pressed. +By default, the hold-tap is configured to also select the 'hold' functionality if another key is tapped while it's active: +While this flavor may work very well for a ctrl/escape key, it's not very well suited for home-row mods or layer-taps. That's why there are more flavors to choose from: 'balanced', 'tap-preferred' and 'tap-unless-interrupted'. +