Disable all input to terminal while a key table is active

[jakenvac]

Hi there, not sure if this already exists but I couldn't find it.

For context:

I have my key table set up to behave modally. I use 'Ctrl + SomeKey' to enter a mode such as pane splitting or resizing. I show which mode I'm in in the right hand status bar.

etc.

A problem I face is that sometimes I forget I'm in a mode and find myself typing a command only to eventually end up accidentally splitting my pane, spawning tabs etc. As a workaround I use the until_unknown in the ActivateKeyTable action to make it so that other keypresses drop me out of the mode. This stops me from accidentally performing actions unless the first key of the command happens to be bound in a mode.

What I'd like to know is would it be possible to disable sending any other key presses to the terminal while one of these key tables are active?

Sorry for the long winded issue. I wasn't sure how else to describe it.

As an aside: I've achieved this modal system with a module I have created to automatically generate these menus and modes as well as assign the key bindings so this feature would be the final piece of the puzzle to make me happy with it for sharing as a 'plugin' of sorts.

[wez]

Sounds reasonable. 6aceb97 adds a prevent_fallback boolean to ActivateKeyTable that will prevent falling back to later key tables.

Can you try that and let me know how it goes?
I can then write up the docs for it.

[wez]

As an aside: I've achieved this modal system with a module I have created to automatically generate these menus and modes as well as assign the key bindings so this feature would be the final piece of the puzzle to make me happy with it for sharing as a 'plugin' of sorts.

Looks great!

[jakenvac]

Can you try that and let me know how it goes?
I can then write up the docs for it.

Ah absolutely, thanks for the heads up! I don't have a lot of time this afternoon but I'll try to get some feedback to you this weekend.

[jankatins]

@jakeHL Any chance to share this code? I would be really interested how to make such tables and such nice UI :-)

[jakenvac]

I'll be sharing it soon. Few things I want to tidy up first. I'll ping you when it's ready 👍🏻

EDIT: @jankatins here is the initial release. Let me know how you find it!
https://github.com/twilsoft/wezmode

[jakenvac]

@wez

Sounds reasonable. 6aceb97 adds a prevent_fallback boolean to ActivateKeyTable that will prevent falling back to later key tables.

I built with the latest commit on main and tried the prevent fallback behavior. I'm not sure if I'm doing something wrong but it seems like no keypresses at all are being registered once I've activated a key table. I'm unable to exit the table with PopKeyTable or perform any other actions.

[wez]

@jakeHL ah, I think I see the issue. Try with the latest main?

[jakenvac]

@wez It works great now, thanks!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.