kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): Fix mod-morph terms from keycodes to bindings

Browse source
This commit is contained in:
Cem Aksoylar 2024-07-26 14:47:27 -07:00
parent 8b909acdcf
commit 9a1fbec5e3
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/docs/behaviors/mod-morph.md
View file

@ -5,18 +5,17 @@ sidebar_label: Mod-Morph
## Summary ## Summary
The Mod-Morph behavior sends a different keypress, depending on whether a specified modifier is being held during the keypress. The mod-morph behavior invokes a different behavior depending on whether any of the specified modifiers are being held during the key press.
- If you tap the key by itself, the first keycode is sent. - If you tap the key by itself, the first behavior binding is activated.
- If you tap the key while holding the specified modifier, the second keycode is sent. - If you tap the key while holding (any of) the specified modifier(s), the second behavior binding is activated.
## Mod-Morph ## Mod-Morph
The Mod-Morph behavior acts as one of two keycodes, depending on if the required modifier is being held during the keypress.
### Configuration ### Configuration
An example of how to implement the mod-morph "Grave Escape": Below is an example of how to implement the mod-morph "Grave Escape". When assigned to a key, pressing the key on its own will send an
Escape keycode but pressing it while a shift or GUI modifier is held sends the grave `` ` `` keycode instead:
```dts ```dts
/ { / {
@ -31,7 +30,7 @@ An example of how to implement the mod-morph "Grave Escape":
}; };
``` ```
Note that this specific mod-morph exists in ZMK by default using code `&gresc`. Note that this specific mod-morph exists in ZMK by default using the binding `&gresc`.
### Behavior Binding ### Behavior Binding
@ -67,7 +66,7 @@ mods = <(MOD_LGUI|MOD_LSFT|MOD_RGUI|MOD_RSFT)>;
### Advanced Configuration ### Advanced Configuration
`keep-mods` #### `keep-mods`
When a modifier specified in `mods` is being held, it won't be sent along with the morphed keycode unless it is also specified in `keep-mods`. By default `keep-mods` equals `0`, which means no modifier specified in `mods` will be sent along with the morphed keycode. When a modifier specified in `mods` is being held, it won't be sent along with the morphed keycode unless it is also specified in `keep-mods`. By default `keep-mods` equals `0`, which means no modifier specified in `mods` will be sent along with the morphed keycode.