diff options
| author | snyman <snyman@users.noreply.github.com> | 2018-03-20 22:59:54 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-03-20 22:59:54 -0400 |
| commit | 7a5ce36f23624b29b548f9e8f8e3a0b165cdf2a4 (patch) | |
| tree | b3d9a72244a49f08b9ef12a1a8376fd05954c67b /docs | |
| parent | 4ec03111cc0dd8cb365aaa43a6aaf2c626d72a61 (diff) | |
| download | firmware-7a5ce36f23624b29b548f9e8f8e3a0b165cdf2a4.tar.gz firmware-7a5ce36f23624b29b548f9e8f8e3a0b165cdf2a4.tar.bz2 firmware-7a5ce36f23624b29b548f9e8f8e3a0b165cdf2a4.zip | |
Add macro for momentarily switching to a layer while some mods are active (#2460)
* Macro for a momentary layer switch with mods
Passes through to the existing ACTION_LAYER_MODS macro, albeit with more
limited options due to lack of space in the quantum_keycodes enum.
* Add documentation for LM layer-mod macro
* Clean up Tap Toggle documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_advanced_keycodes.md | 3 | ||||
| -rw-r--r-- | docs/keycodes.md | 17 |
2 files changed, 11 insertions, 9 deletions
diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md index ceee7fad1..f61d78d50 100644 --- a/docs/feature_advanced_keycodes.md +++ b/docs/feature_advanced_keycodes.md @@ -25,7 +25,8 @@ These functions allow you to activate layers in various ways. * `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped. * `TG(layer)` - toggles a layer on or off. * `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed). -* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps. +* `TT(layer)` - Layer Tap-Toggle. If you hold the key down, the layer becomes active, and then deactivates when you let go. And if you repeatedly tap it, the layer simply becomes active (toggles on). It needs 5 taps by default, but you can set it by defining `TAPPING_TOGGLE`, for example, `#define TAPPING_TOGGLE 2` for just two taps. +* `LM(layer, mod)` - Momentary switch to *layer* (like MO), but with modifier(s) *mod* active. Only supports layers 0-15 and the left modifiers. # Working with Layers diff --git a/docs/keycodes.md b/docs/keycodes.md index 0f7968e7d..dad645cf0 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -368,14 +368,15 @@ This is a reference only. Each group of keys links to the page documenting their ## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers) -|Key |Description | -|---------------|----------------------------------------------------------------------------------| -|`LT(layer, kc)`|Turn on `layer` when held, `kc` when tapped | -|`TO(layer)` |Turn on `layer` when pressed | -|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)| -|`DF(layer)` |Set the base (default) layer | -|`TG(layer)` |Toggle `layer` on or off | -|`TT(layer)` |Tap toggle? idk FIXME | +|Key |Description | +|----------------|----------------------------------------------------------------------------------| +|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped | +|`TO(layer)` |Turn on `layer` when pressed | +|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)| +|`DF(layer)` |Set the base (default) layer | +|`TG(layer)` |Toggle `layer` on or off | +|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | +|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. | ## [One Shot Keys](quantum_keycodes.md#one-shot-keys) |