From 96f1537a0ef90a983c0055605008f825ea6d791b Mon Sep 17 00:00:00 2001 From: Nick Conway Date: Mon, 16 Jun 2025 14:03:00 -0400 Subject: [PATCH] docs(leader-key): update leader key docs for overlap timeout --- docs/docs/keymaps/behaviors/leader-key.md | 43 +++++++++++------------ 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/docs/keymaps/behaviors/leader-key.md b/docs/docs/keymaps/behaviors/leader-key.md index 0b8ecd279..7aed3d051 100644 --- a/docs/docs/keymaps/behaviors/leader-key.md +++ b/docs/docs/keymaps/behaviors/leader-key.md @@ -7,35 +7,15 @@ sidebar_label: Leader Key The leader key behavior when triggered will capture all following key presses and trigger a leader sequence's behavior if pressed. -### Behavior Binding - -- Reference: `&leader` - -Example: - -``` -&leader -``` - ### Configuration #### `timeout-ms` Defines the amount of time to wait to trigger a completed leader sequence. Defaults to no timeout and will wait indefinitely. -To change the timeout term, you can update the existing behavior: +#### `overlap-timeout-ms` -``` -&leader { - timeout-ms = <500>; -}; - -/ { - keymap { - ... - }; -}; -``` +Defines the amount of time to wait to trigger a completed leader sequence after an overlapping sequence is completed. Defaults to 200ms. ### Leader Sequences @@ -83,6 +63,25 @@ Add the same leader key to both sides to be able to reset either side. :::: +### Example Usage + +``` +leader: leader { + compatible = "zmk,behavior-leader-key"; + binding-cells = <0>; + + seq_b { + key-positions = <1 1>; + bindings = <&kp B>; + }; + + seq_c { + key-positions = <1>; + bindings = <&kp C>; + }; +}; +``` + ### Advanced usage See [leader configuration](../../config/leader.md) for advanced configuration options.