diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/config_options.md | 2 | ||||
-rw-r--r-- | docs/feature_leader_key.md | 6 |
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 879761a40..4bbc5debd 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
@@ -146,6 +146,8 @@ If you define these options you will enable the associated feature, which may in | |||
146 | * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped. | 146 | * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped. |
147 | * `#define LEADER_PER_KEY_TIMING` | 147 | * `#define LEADER_PER_KEY_TIMING` |
148 | * sets the timer for leader key chords to run on each key press rather than overall | 148 | * sets the timer for leader key chords to run on each key press rather than overall |
149 | * `#define LEADER_KEY_STRICT_KEY_PROCESSING` | ||
150 | * Disables keycode filtering for Mod-Tap and Layer-Tap keycodes. Eg, if you enable this, you would need to specify `MT(MOD_CTL, KC_A)` if you want to use `KC_A`. | ||
149 | * `#define ONESHOT_TIMEOUT 300` | 151 | * `#define ONESHOT_TIMEOUT 300` |
150 | * how long before oneshot times out | 152 | * how long before oneshot times out |
151 | * `#define ONESHOT_TAP_TOGGLE 2` | 153 | * `#define ONESHOT_TAP_TOGGLE 2` |
diff --git a/docs/feature_leader_key.md b/docs/feature_leader_key.md index 168a1fc1c..82cf78901 100644 --- a/docs/feature_leader_key.md +++ b/docs/feature_leader_key.md | |||
@@ -72,6 +72,12 @@ SEQ_THREE_KEYS(KC_C, KC_C, KC_C) { | |||
72 | } | 72 | } |
73 | ``` | 73 | ``` |
74 | 74 | ||
75 | ## Strict Key Processing | ||
76 | |||
77 | By default, the Leader Key feature will filter the keycode out of [`Mod-Tap`](feature_advanced_keycodes.md#mod-tap) and [`Layer Tap`](feature_advanced_keycodes.md#switching-and-toggling-layers) functions when checking for the Leader sequences. That means if you're using `LT(3, KC_A)`, it will pick this up as `KC_A` for the sequence, rather than `LT(3, KC_A)`, giving a more expected behavior for newer users. | ||
78 | |||
79 | While, this may be fine for most, if you want to specify the whole keycode (eg, `LT(3, KC_A)` from the example above) in the sequence, you can enable this by added `#define LEADER_KEY_STRICT_KEY_PROCESSING` to your `config.h` file. This well then disable the filtering, and you'll need to specify the whole keycode. | ||
80 | |||
75 | ## Customization | 81 | ## Customization |
76 | 82 | ||
77 | The Leader Key feature has some additional customization to how the Leader Key feature works. It has two functions that can be called at certain parts of the process. Namely `leader_start()` and `leader_end()`. | 83 | The Leader Key feature has some additional customization to how the Leader Key feature works. It has two functions that can be called at certain parts of the process. Namely `leader_start()` and `leader_end()`. |