diff options
author | Drashna Jaelre <drashna@live.com> | 2019-09-21 11:22:27 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-21 11:22:27 -0700 |
commit | f069e9fc09859baf03d940b6db47e95c50a24936 (patch) | |
tree | 429cd294d22c0a9af6965af68f047e9482fc0cef /docs | |
parent | 63a0b1241d204873cd5156a959e913c602b0c386 (diff) | |
download | firmware-f069e9fc09859baf03d940b6db47e95c50a24936.tar.gz firmware-f069e9fc09859baf03d940b6db47e95c50a24936.tar.bz2 firmware-f069e9fc09859baf03d940b6db47e95c50a24936.zip |
Generalize Tap Dance Layer functions (#6629)
* made tapdance dual_role general
* updated original dual_role functionality
* added toggling layer example
* Fix dual role and add alias
* Update docs about new layer tap dances
* Fix up based on feedback
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_tap_dance.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_tap_dance.md b/docs/feature_tap_dance.md index 73e0471a0..e381c2af0 100644 --- a/docs/feature_tap_dance.md +++ b/docs/feature_tap_dance.md @@ -30,7 +30,9 @@ Next, you will want to define some tap-dance keys, which is easiest to do with t After this, you'll want to use the `tap_dance_actions` array to specify what actions shall be taken when a tap-dance key is in action. Currently, there are five possible options: * `ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when tapped once, `kc2` otherwise. When the key is held, the appropriate keycode is registered: `kc1` when pressed and held, `kc2` when tapped once, then pressed and held. -* `ACTION_TAP_DANCE_DUAL_ROLE(kc, layer)`: Sends the `kc` keycode when tapped once, or moves to `layer`. (this functions like the `TO` layer keycode). +* `ACTION_TAP_DANCE_LAYER_MOVE(kc, layer)`: Sends the `kc` keycode when tapped once, or moves to `layer`. (this functions like the `TO` layer keycode). + * This is the same as `ACTION_TAP_DANCE_DUAL_ROLE`, but renamed to something that is clearer about its functionality. Both names will work. +* `ACTION_TAP_DANCE_LAYER_TOGGLE(kc, layer)`: Sends the `kc` keycode when tapped once, or toggles the state of `layer`. (this functions like the `TG` layer keycode). * `ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in the user keymap - with the final tap count of the tap dance action. * `ACTION_TAP_DANCE_FN_ADVANCED(on_each_tap_fn, on_dance_finished_fn, on_dance_reset_fn)`: Calls the first specified function - defined in the user keymap - on every tap, the second function when the dance action finishes (like the previous option), and the last function when the tap dance action resets. * `ACTION_TAP_DANCE_FN_ADVANCED_TIME(on_each_tap_fn, on_dance_finished_fn, on_dance_reset_fn, tap_specific_tapping_term)`: This functions identically to the `ACTION_TAP_DANCE_FN_ADVANCED` function, but uses a custom tapping term for it, instead of the predefined `TAPPING_TERM`. |