aboutsummaryrefslogtreecommitdiff
path: root/tmk_core/doc/keymap.md
diff options
context:
space:
mode:
Diffstat (limited to 'tmk_core/doc/keymap.md')
-rw-r--r--tmk_core/doc/keymap.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/tmk_core/doc/keymap.md b/tmk_core/doc/keymap.md
index d4a129b20..4d42fbe5c 100644
--- a/tmk_core/doc/keymap.md
+++ b/tmk_core/doc/keymap.md
@@ -528,14 +528,20 @@ This is a feature to assign both toggle layer and momentary switch layer action
528 528
529 529
530### 4.3 Oneshot Modifier 530### 4.3 Oneshot Modifier
531This runs onetime effects which modify only on just one following key. It works as normal modifier key when holding down while oneshot modifier when tapping. 531This runs onetime effects which modify only on just one following key. It works as normal modifier key when holding down while oneshot modifier when tapping. The behavior of oneshot modifiers is similar to the [sticky keys](https://en.wikipedia.org/wiki/StickyKeys) functionality found in most operating systems.
532 532
533 ACTION_MODS_ONESHOT(MOD_LSFT) 533 ACTION_MODS_ONESHOT(MOD_LSFT)
534 534
535Oneshot layer key:
536
537 ACTION_LAYER_ONESHOT(MY_LAYER)
538
535Say you want to type 'The', you have to push and hold Shift key before type 't' then release it before type 'h' and 'e', otherwise you'll get 'THe' or 'the' unintentionally. With Oneshot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly here. This mean you can release Shift before 't' is pressed down. 539Say you want to type 'The', you have to push and hold Shift key before type 't' then release it before type 'h' and 'e', otherwise you'll get 'THe' or 'the' unintentionally. With Oneshot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly here. This mean you can release Shift before 't' is pressed down.
536 540
537Oneshot effect is cancel unless following key is pressed down within `ONESHOT_TIMEOUT` of `config.h`. No timeout when it is `0` or not defined. 541Oneshot effect is cancel unless following key is pressed down within `ONESHOT_TIMEOUT` of `config.h`. No timeout when it is `0` or not defined.
538 542
543Most implementations of sticky keys allow you to lock a modifier by double tapping the modifier. The layer then remains locked untill the modifier is tapped again. To enable this behaviour for oneshot modifiers set `ONESHOT_TAP_TOGGLE` to the number taps required. The feature is disabled if `ONESHOT_TAP_TOGGLE<2` or not defined.
544
539 545
540### 4.4 Tap Toggle Mods 546### 4.4 Tap Toggle Mods
541Similar to layer tap toggle, this works as a momentary modifier when holding, but toggles on with several taps. A single tap will 'unstick' the modifier again. 547Similar to layer tap toggle, this works as a momentary modifier when holding, but toggles on with several taps. A single tap will 'unstick' the modifier again.