starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Unable to read keypresses using ($host.UI.RawUI.ReadKey('NoEcho,IncludeKeyUp')).character #13269

New Issue
Closed
opened 2026-01-31 03:38:17 +00:00 by claunia · 3 comments
claunia commented 2026-01-31 03:38:17 +00:00
Owner
Copy Link

Originally created by @jameswylde on GitHub (Apr 1, 2021).

Windows Terminal version (or Windows build number)

10.0.18363.0
Latest WT and WT preview

Other Software

Powershell 7.1.3
Powershell 5.1.18362.1171

Tested on both current WT and WT Preview, same results.

Steps to reproduce

Simple TUI to demonstrate:

do
{
     Show-Menu
     $keyPress = ($host.UI.RawUI.ReadKey('NoEcho,IncludeKeyUp')).character
     switch ($keyPress)
     {
           '1' {
                Clear-Host
                functionHere
           } 'Q' {
                return
           }
     }
     pause
}
until ($keyPress -eq 'q')

Expected Behavior

Powershell to progress and ReadKey from input.

Actual Behavior

Input is detected (writes into terminal) however on enter disappears and no action is executed.

Working fine in normal PS shells (version numbers above).

Originally created by @jameswylde on GitHub (Apr 1, 2021). ### Windows Terminal version (or Windows build number) 10.0.18363.0 Latest WT and WT preview ### Other Software Powershell 7.1.3 Powershell 5.1.18362.1171 Tested on both current WT and WT Preview, same results. ### Steps to reproduce Simple TUI to demonstrate: ``` do { Show-Menu $keyPress = ($host.UI.RawUI.ReadKey('NoEcho,IncludeKeyUp')).character switch ($keyPress) { '1' { Clear-Host functionHere } 'Q' { return } } pause } until ($keyPress -eq 'q') ``` ### Expected Behavior Powershell to progress and ReadKey from input. ### Actual Behavior Input is detected (writes into terminal) however on enter disappears and no action is executed. Working fine in normal PS shells (version numbers above).
claunia added the Resolution-By-DesignNeeds-TriageNeeds-Tag-FixNeeds-Attention labels 2026-01-31 03:38:18 +00:00
claunia commented 2026-01-31 03:38:18 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Apr 13, 2021):

Thanks for the report! I don't have a Show-Menu commandlet -- can you point me to a module? Did you author this yourself?

@DHowett commented on GitHub (Apr 13, 2021): Thanks for the report! I don't have a `Show-Menu` commandlet -- can you point me to a module? Did you author this yourself?
claunia commented 2026-01-31 03:38:19 +00:00
Author
Owner
Copy Link

@jameswylde commented on GitHub (Apr 13, 2021):

Apologies Dustin, that's actually a function I named whilst quickly whipping up the above to demonstrate the issue - poorly named. Why I used a cmdlet naming convention I have no idea.

So Show-Menu would simply write to host something like:

function Show-Menu
{
     param (
           [string]$Title = "Title"
     )
     Clear-Host
     Write-Host "Option 1"
     Write-Host "Option 2"
}

Apologies I didn't include, I didn't think it relevant. Let me know if you need anything else.

@jameswylde commented on GitHub (Apr 13, 2021): Apologies Dustin, that's actually a function I named whilst quickly whipping up the above to demonstrate the issue - poorly named. Why I used a cmdlet naming convention I have no idea. So Show-Menu would simply write to host something like: ``` function Show-Menu { param ( [string]$Title = "Title" ) Clear-Host Write-Host "Option 1" Write-Host "Option 2" } ``` Apologies I didn't include, I didn't think it relevant. Let me know if you need anything else.
claunia commented 2026-01-31 03:38:19 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Apr 13, 2021):

Okay, so I think this is another case of ... well, this is pretty curious. When you press enter, we stuff an enter DOWN and an enter UP key into the input buffer. Because you're accepting a read on Key Up, you're immediately getting the "enter key up" event that you get from either pressing enter on the prompt line or enter after pause. If you press enter slowly in the traditional console, you can see this as well.

Recommendations are to either flush input (which I am not sure how to do from PS or .NET), or to not read key up events. They're relatively uncommonly used as far as we can tell. 😄

Marking this by-design. There's a couple other issues floating around for this that I may come back and deduplicate with this one.

Cheers!

@DHowett commented on GitHub (Apr 13, 2021): Okay, so I think this is another case of ... well, this is pretty curious. When you press enter, we stuff an enter DOWN and an enter UP key into the input buffer. Because you're accepting a read on Key Up, you're immediately getting the "enter key up" event that you get from either pressing enter on the prompt line or enter after `pause`. If you press enter slowly in the traditional console, you can see this as well. Recommendations are to either flush input (which I am not sure how to do from PS or .NET), or to not read key _up_ events. They're relatively uncommonly used as far as we can tell. :smile: Marking this by-design. There's a couple other issues floating around for this that I may come back and deduplicate with this one. Cheers!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Needs-Attention Needs-Tag-Fix Needs-Triage Resolution-By-Design
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#13269
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?