diff options
author | Will Spooner <[email protected]> | 2025-01-02 07:12:58 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2025-01-01 23:12:58 -0800 |
commit | b603094995fad1498204cbabdb47b85e76780446 (patch) | |
tree | b6b0c7fbf979919f84756fb3315696c42b4fb56b /docs | |
parent | e016b9b4c5c28b4a0a7ae2fbb7cbe7e090169438 (diff) | |
download | qmk_firmware-b603094995fad1498204cbabdb47b85e76780446.tar.gz qmk_firmware-b603094995fad1498204cbabdb47b85e76780446.zip |
Add leader_add_user callback (#24266)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/features/leader_key.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/features/leader_key.md b/docs/features/leader_key.md index a36e630a36..9f9086e1ae 100644 --- a/docs/features/leader_key.md +++ b/docs/features/leader_key.md @@ -154,6 +154,21 @@ User callback, invoked when the leader sequence ends. --- +### `bool leader_add_user(uint16_t keycode)` {#api-leader-add-user} + +User callback, invoked when a keycode is added to the leader sequence. + +#### Arguments {#api-leader-add-user-arguments} + + - `uint16_t keycode` + The keycode to added to the leader sequence. + +#### Return Value {#api-leader-add-user-return} + +`true` to finish the key sequence, `false` to continue. + +--- + ### `void leader_start(void)` {#api-leader-start} Begin the leader sequence, resetting the buffer and timer. |