prompt-toolkit / prompt-toolkit/python-prompt-toolkit

How to override Enter in a CheckboxList?

Open
#1,909 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

A CheckboxList allows toggling the state of the current item by either Enter or Space. I'd like to use Space to toggle and Enter for another purpose. But when I add a KeyBinding to handle enter, that key still toggles state.

How can I override this key when focus is on a CheckboxList?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CheckboxList key handling and the KeyBinding resolution path for Enter and Space. Check how the existing Enter toggle is selected and whether a custom binding can take precedence. Done means Enter serves another binding while Space still toggles the current item.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.