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

update docs

Browse source
This commit is contained in:
jding 2021-11-01 18:23:33 +00:00
parent a149beb6f2
commit f245d9761c
1 changed files with 62 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
docs/docs/behaviors/hold-tap.md
View file

@ -104,8 +104,39 @@ For example, if you press `&mt LEFT_SHIFT A` and then release it without pressin
#### Home row mods #### Home row mods
This example configures a hold-tap that works well for homerow mods: The following are suggested hold-tap configurations that work well with home row mods:
##### Option 1: cross-hand only modifiers, using `tap-unless-interrupted` and positional hold-tap (`hold-trigger-key-positions`)
```
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
/ {
behaviors {
lh_pht: left_hand_positional_hold_tap {
compatible = "zmk,behavior-hold-tap";
label = "POSITIONAL_HOLD_TAP";
#binding-cells = <2>;
flavor = "tap-unless-interrupted";
tapping-term-ms = <100>; // <---[[produces tap if held longer than tapping-term-ms]]
quick-tap-ms = <200>;
bindings = <&kp>, <&kp>;
hold-trigger-key-positions = <5 6 7 8 9 10>; // <---[[right-hand keys]]
};
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
// position 0 pos 1 pos 2 pos 3 pos 4 pos 5 pos 6 pos 7 pos 8 pos 9 pos 10
&lh_pht LSFT A &lh_pht LGUI S &lh_pht LALT D &lh_pht LCTL F &kp G &kp H &kp I &kp J &kp K &kp L &kp SCLN
>;
};
};
};
```
##### Option 2: `tap-preferred`
``` ```
#include <behaviors.dtsi> #include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h> #include <dt-bindings/zmk/keys.h>
@ -125,7 +156,6 @@ This example configures a hold-tap that works well for homerow mods:
keymap { keymap {
compatible = "zmk,keymap"; compatible = "zmk,keymap";
default_layer { default_layer {
bindings = < bindings = <
&hm LCTRL A &hm LGUI S &hm LALT D &hm LSHIFT F &hm LCTRL A &hm LGUI S &hm LALT D &hm LSHIFT F
@ -136,7 +166,36 @@ This example configures a hold-tap that works well for homerow mods:
``` ```
If this config does not work for you, try the flavor "balanced" with a medium `tapping-term-ms` such as 200ms. ##### Option 3: `balanced`
```
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
/ {
behaviors {
bhm: balanced_homerow_mods {
compatible = "zmk,behavior-hold-tap";
label = "HOMEROW_MODS";
#binding-cells = <2>;
tapping-term-ms = <200>; // <---[[moderate duration]]
quick_tap_ms = <0>;
flavor = "balanced";
bindings = <&kp>, <&kp>;
};
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
&bhm LCTRL A &bhm LGUI S &bhm LALT D &bhm LSHIFT F
>;
};
};
};
```
#### Comparison to QMK #### Comparison to QMK