diff options
| author | Drashna Jaelre <drashna@live.com> | 2021-03-01 08:57:02 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-01 08:57:02 -0800 |
| commit | 0e984b6e7e216a62df0b5d53f6a8f0d4bc13dca3 (patch) | |
| tree | 1e85b1d15a9ea6ad86fcb6ae8d084f926dd11ab8 /docs | |
| parent | 86f6f682744b81bba1003e555f902af78dcdaad4 (diff) | |
Add ability to toggle One Shot functionality (#4198)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/keycodes.md | 3 | ||||
| -rw-r--r-- | docs/one_shot_keys.md | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md index 9acf8b6839..f3c519b130 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -516,6 +516,9 @@ See also: [One Shot Keys](one_shot_keys.md) |------------|----------------------------------| |`OSM(mod)` |Hold `mod` for one keypress | |`OSL(layer)`|Switch to `layer` for one keypress| +|`OS_ON` |Turns One Shot keys on | +|`OS_OFF` |Turns One Shot keys off | +|`OS_TOGG` |Toggles One Shot keys status | ## Space Cadet :id=space-cadet diff --git a/docs/one_shot_keys.md b/docs/one_shot_keys.md index 9a082d7d6d..9fc5486299 100644 --- a/docs/one_shot_keys.md +++ b/docs/one_shot_keys.md @@ -17,6 +17,9 @@ You can control the behavior of one shot keys by defining these in `config.h`: * `OSM(mod)` - Momentarily hold down *mod*. You must use the `MOD_*` keycodes as shown in [Mod Tap](mod_tap.md), not the `KC_*` codes. * `OSL(layer)` - momentary switch to *layer*. +* `OS_ON` - Turns on One Shot keys. +* `OS_OFF` - Turns off One Shot keys. OSM act as regular mod keys, OSL act like `MO`. +* `ON_TOGG` - Toggles the one shot key status. Sometimes, you want to activate a one-shot key as part of a macro or tap dance routine. |