2ccad46e26
* update modtap to holdtap * Update links * Revert "Update links" This reverts commit 8d0cda7c5a43c84dd18b927cb73672158e4f8abc. * updated docs links update links in docs * Update docs/en/Getting_Started.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/Getting_Started.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * rename modtap.md to holdtap.md * Update Getting_Started.md * Update main.py * Update modtap.py * Update modtap.py and add notice * Update docs/en/porting_to_kmk.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/handwiring.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/contributing.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/contributing.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/ble_hid.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/Getting_Started.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/Getting_Started.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Update docs/en/kmkpython_vs_circuitpython.md Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com> * Rename modtap.md to holdtap.md * fixup --------- Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
52 lines
3.2 KiB
Markdown
52 lines
3.2 KiB
Markdown
# HoldTap Keycodes
|
|
Enabling HoldTap will give you access to the following keycodes and can simply be
|
|
added to the modules list.
|
|
|
|
```python
|
|
from kmk.modules.holdtap import HoldTap
|
|
holdtap = HoldTap()
|
|
# optional: set a custom tap timeout in ms
|
|
# holdtap.tap_time = 300
|
|
keyboard.modules.append(holdtap)
|
|
```
|
|
|
|
## Keycodes
|
|
|
|
|New Keycode | Description |
|
|
|---------------------------------------------------------|-----------------------------------------------------------------|
|
|
|`LCTL = KC.HT(KC.SOMETHING, KC.LCTRL)` |`LCTRL` if held `kc` if tapped |
|
|
|`LSFT = KC.HT(KC.SOMETHING, KC.LSFT)` |`LSHIFT` if held `kc` if tapped |
|
|
|`LALT = KC.HT(KC.SOMETHING, KC.LALT)` |`LALT` if held `kc` if tapped |
|
|
|`LGUI = KC.HT(KC.SOMETHING, KC.LGUI)` |`LGUI` if held `kc` if tapped |
|
|
|`RCTL = KC.HT(KC.SOMETHING, KC.RCTRL)` |`RCTRL` if held `kc` if tapped |
|
|
|`RSFT = KC.HT(KC.SOMETHING, KC.RSFT)` |`RSHIFT` if held `kc` if tapped |
|
|
|`RALT = KC.HT(KC.SOMETHING, KC.RALT)` |`RALT` if held `kc` if tapped |
|
|
|`RGUI = KC.HT(KC.SOMETHING, KC.RGUI)` |`RGUI` if held `kc` if tapped |
|
|
|`SGUI = KC.HT(KC.SOMETHING, KC.LSHFT(KC.LGUI))` |`LSHIFT` and `LGUI` if held `kc` if tapped |
|
|
|`LCA = KC.HT(KC.SOMETHING, KC.LCTRL(KC.LALT))` |`LCTRL` and `LALT` if held `kc` if tapped |
|
|
|`LCAG = KC.HT(KC.SOMETHING, KC.LCTRL(KC.LALT(KC.LGUI)))` |`LCTRL` and `LALT` and `LGUI` if held `kc` if tapped |
|
|
|`MEH = KC.HT(KC.SOMETHING, KC.LCTRL(KC.LSFT(KC.LALT)))` |`CTRL` and `LSHIFT` and `LALT` if held `kc` if tapped |
|
|
|`HYPR = KC.HT(KC.SOMETHING, KC.HYPR)` |`LCTRL` and `LSHIFT` and `LALT` and `LGUI` if held `kc` if tapped|
|
|
|
|
## Custom HoldTap Behavior
|
|
The full HoldTap signature is as follows:
|
|
```python
|
|
KC.HT(KC.TAP, KC.HOLD, prefer_hold=True, tap_interrupted=False, tap_time=None, repeat=HoldTapRepeat.NONE)
|
|
```
|
|
* `prefer_hold`: decides which keycode the HoldTap key resolves to when another
|
|
key is pressed before the timeout finishes. When `True` the hold keycode is
|
|
chosen, the tap keycode when `False`.
|
|
* `tap_interrupted`: decides if the timeout will interrupt at the first other
|
|
key press/down, or after the first other key up/release. Set to `True` for
|
|
interrupt on release.
|
|
* `tap_time`: length of the tap timeout in milliseconds.
|
|
* `repeat`: decides how to interpret repeated presses if they happen within
|
|
`tap_time` after a release.
|
|
* `TAP`: repeat tap action, if previous action was a tap.
|
|
* `HOLD`: repeat hold action, if previous action was a hold.
|
|
* `ALL`: repeat all of the above.
|
|
* `NONE`: no repeat action (default), everything works as expected.
|
|
The `HoldTapRepeat` enum must be imported from `kmk.modules.holdtap`.
|
|
|
|
Each of these parameters can be set for every HoldTap key individually.
|