Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add leader_add_user callback #24266

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/features/leader_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions quantum/leader.c
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ __attribute__((weak)) void leader_start_user(void) {}

__attribute__((weak)) void leader_end_user(void) {}

__attribute__((weak)) bool leader_add_user(uint16_t keycode) {
return false;
}

void leader_start(void) {
if (leading) {
return;
Expand Down Expand Up @@ -61,6 +65,9 @@ bool leader_sequence_add(uint16_t keycode) {
leader_sequence[leader_sequence_size] = keycode;
leader_sequence_size++;

if (leader_add_user(keycode)) {
leader_end();
}
return true;
}

Expand Down
9 changes: 9 additions & 0 deletions quantum/leader.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ void leader_start_user(void);
*/
void leader_end_user(void);

/**
* \brief User callback, invoked when a keycode is added to the leader sequence.
*
* \param keycode The keycode added to the leader sequence.
*
* \return `true` to finish the key sequence, `false` to continue.
*/
bool leader_add_user(uint16_t keycode);

/**
* Begin the leader sequence, resetting the buffer and timer.
*/
Expand Down