Duplicate Key Events on Windows

[dev-ardi]

Issue summary

On Windows, Crossterm will report both KeyPress and KeyRelease events. To avoid registering an event twice, ensure that you check the kind field of the KeyEvent. See also:

• https://docs.rs/crossterm/latest/crossterm/event/struct.KeyEvent.html#structfield.kind
• https://docs.rs/crossterm/latest/crossterm/event/enum.KeyEventKind.html
• The table widget example is misguiding #120
• odd behavour on windows #166
• Support key release events for windows. crossterm-rs/crossterm#745
• Make release event an opt-in feature  crossterm-rs/crossterm#778

Description

When I type any keyboard input the event fires twice: Once on press and once on release.

2023-07-26.06-29-42.mp4

To Reproduce

https://github.com/fdehau/tui-rs/blob/master/examples/user_input.rs

Environment

• OS: Windows
• Terminal Emulator: conhost, alacritty
• Crate version: ratatui = "0.22.0"
• Backend: crossterm

Additional context

It works for some reason in another project where it was failing until I refactored the display logic to another function

[joshka]

Hi there. This has come up a few times. See https://docs.rs/crossterm/latest/crossterm/event/struct.KeyEvent.html
To fix this, check KeyEvent.kind == KeyEventKind.Press (on windows).

That's a probably a difficult one as ratatui doesn't have any code to handle keyboard input (other than our examples). Can you help us out (and perhaps the next person who hits this) by noting where in the docs you looked for this and didn't find enough info?

[dev-ardi]

Honestly the only docs I read were the readme.md and the examples, and also the relevant data structures and methods that I used.

But the examples are wrong on windows though!

[mindoodoo]

But the examples are wrong on windows though!

Could you elaborate on why they are wrong ?

[dev-ardi]

Well the expected behaviour would be that the down key only moves down by one but it moves down by two!

[dev-ardi]

Ah, I'm very dumb. I took the example from tui-rs not ratatui. I'm sorry about that!

[mindoodoo]

So that fixes your issue ?

[dev-ardi]

Yes. tui-rs should be officially deprecated at this point...