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

Add ignore-modifiers setting to skq example

Browse source 
Also clarify the need of having ignore-modifiers when combining multiple modifiers in a single tap.
This commit is contained in:
Josep Roca 2023-04-15 21:03:56 +03:00 • committed by GitHub
parent 59f699d4c0
commit 2971e5ea0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/docs/behaviors/sticky-key.md
View file

@ -36,7 +36,7 @@ Some typists may find that using a sticky shift key interspersed with rapid typi
#### `ignore-modifiers` #### `ignore-modifiers`
This setting is enabled by default. It ensures that if a sticky key modifier is pressed before a previously pressed sticky key is released, the modifiers will get combined so you can add more sticky keys or press a regular key to apply the modifiers. This is to accommodate _callum-style mods_ where you are prone to rolling sticky keys. If you want sticky key modifiers to only chain after release, you can disable this setting. This setting is enabled by default. It ensures that if a sticky key modifier is pressed before a previously pressed sticky key is released, the modifiers will get combined so you can add more sticky keys or press a regular key to apply the modifiers. This is to accommodate _callum-style mods_ where you are prone to rolling sticky keys. If you want sticky key modifiers to only chain after release, you can disable this setting. Please note that [modifier functions](https://zmk.dev/docs/codes/modifiers#modifier-functions), such as `&sk LS(LALT)`, require `ignore-modifiers` enabled in order to function properly.
#### Example #### Example
@ -66,6 +66,7 @@ This configuration would apply to all sticky keys. This may not be appropriate i
bindings = <&kp>; bindings = <&kp>;
release-after-ms = <1000>; release-after-ms = <1000>;
quick-release; quick-release;
ignore-modifiers;
}; };
}; };
@ -75,8 +76,6 @@ This configuration would apply to all sticky keys. This may not be appropriate i
}; };
``` ```
If you combine multiple modifiers in a single key, like for example `&skq LS(LALT)`, you might need to add the `ignore-modifiers;` setting because it is not inherited from the default `&sk` behavior.
### Advanced usage ### Advanced usage
Sticky keys can be combined; if you tap `&sk LCTRL` and then `&sk LSHIFT` and then `&kp A`, the output will be ctrl+shift+a. Sticky keys can be combined; if you tap `&sk LCTRL` and then `&sk LSHIFT` and then `&kp A`, the output will be ctrl+shift+a.