Update Mod-Tap, Layer-Tap, and Hold-Tap to better reference each other

This commit is contained in:
Kurtis Lew 2022-06-06 22:26:25 -07:00
parent 7b5296560d
commit 0721c30a98
3 changed files with 16 additions and 4 deletions

View file

@ -37,7 +37,7 @@ When the hold-tap key is released and the hold behavior has not been triggered,
### Basic usage
For basic usage, please see [mod-tap](mod-tap.md) and [layer-tap](layers.md) pages.
For basic usage, please see the [mod-tap](mod-tap.md) and [layer-tap](layers.md) pages.
### Advanced Configuration

View file

@ -43,7 +43,7 @@ Example:
## Layer-tap
The "layer-tap" behavior enables a layer when a key is held, and output another key when the key is only tapped for a short time. For more information on the inner workings of layer-tap, see [hold-tap](hold-tap.md).
The "layer-tap" behavior enables a layer when a key is held, and outputs a [keypress](key-press.md) when the key is only tapped for a short time.
### Behavior Binding
@ -57,6 +57,14 @@ Example:
&lt LOWER SPACE
```
:::info
Functionally, the layer-tap is a ["hold-preferred" flavor](hold-tap.md/#flavors) of [hold-tap](hold-tap.md) with a [`tapping-term-ms`](hold-tap.md/#tapping-term-ms) of 200 that takes in a [`momentary layer`](#momentary-layer) and a [keypress](key-press.md) as its "hold" and "tap" parameters respectively.
For users looking to create a keybind like the layer-tap that depending on how long the key is held, invokes behaviors like [sticky keys](sticky-key.md) or [key toggles](key-toggle.md), see [Hold-Tap](hold-tap.md).
Similarly, for users who want to send a different [keycode](../codes/index.mdx) depending on if the same key is held or tapped, see [Mod-Tap](mod-tap.md).
:::
## To Layer
The "to layer" behavior enables a layer and disables _all_ other layers _except_ the default layer.

View file

@ -44,6 +44,10 @@ You can configure a different tapping term in your keymap:
};
```
### Additional information
:::info
Under the hood, the mod-tap is simply a ["hold-preferred" flavor](hold-tap.md/#flavors) of [hold-tap](hold-tap.md) with a [`tapping-term-ms`](hold-tap.md/#tapping-term-ms) of 200 that takes in two [keypresses](key-press.md) as its "hold" and "tap" parameters. This means that the mod-tap can be used to invoke **any** [keycode](../codes/index.mdx), and is not limited to only activating [modifier keys](../codes/modifiers.mdx) when it is held.
The mod-tap is a [hold-tap](hold-tap.md) under the hood with the "hold-preferred" flavor and tapping-term-ms 200.
For users looking to create a keybind like the mod-tap that invokes behaviors _other_ than [keypresses](key-press.md), like [sticky keys](sticky-key.md) or [key toggles](key-toggle.md), see [Hold-Tap](hold-tap.md).
Similarly, for users who want to momentarily access a specific [layer](../features/keymaps#layers) while a key is held and send a keycode when the same key is tapped, see [Layer-Tap](layers.md/#layer-tap).
:::