review updates and renamed to Sticky Mod

This commit is contained in:
Syed Hussaini
2022-04-28 11:05:59 -05:00
committed by xs5871
parent a0efbb92d5
commit 660b751c87
5 changed files with 96 additions and 93 deletions

22
docs/sticky_mod.md Normal file
View File

@@ -0,0 +1,22 @@
# Sticky Mod
This module allows to immitate the behaviour of ATL+TAB or CMD+TAB, etc. for switching between open windows.
The mod will be on hold and the key will be tapped. The mod will be released when any other key is pressed or the layer key is released.
## Enabling the module
```python
from kmk.module.sticky_mod import StickyMod
sticky_mod = StickyMod()
keyboard.modules.append(sticky_mod)
keyboard.keymap = [
[
KC.SM(kc=KC.TAB, mod=KC.LALT),
KC.SM(KC.TAB, KC.LSFT(KC.LALT)),
],
]
```
## Keycodes
|Key |Description |
|-------------------------|-----------------------------------------------|
|`KC.SM(KC.key, KC.mod)` |sticky mod |