Files
PowerToys/.github/ISSUE_TEMPLATE/bug_report.yml
Miranda Zheng 459dd2fa37 KeystrokeOverlay: New PowerToys module for on screen key strokes (#44250)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
This pull request introduces the new KeystrokeOverlay module to
PowerToys, including its documentation, build configuration, installer
setup, and spell-check dictionary updates. KeystrokeOverlay can be used
to show keys pressed on the screen like Visual Studio Code's Screencast
Mode.

It provides customization options for text size and background, offers
four types of display modes, and three shortcuts for toggling on/off the
display, cycling through monitors, and through different display modes
(see below for more details).

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] Closes: #981 
<!-- - [ ] Closes: #yyy (add separate lines for additional resolved
issues) -->
- [x] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [x] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
**KeystrokeOverlay Module Integration:**

* Added KeystrokeOverlay as a new module in the solution, with
corresponding projects for the keyboard service, UI, and module
interface (`PowerToys.slnx`).
* Added documentation for the Keystroke Overlay module, including
architecture, usage, and debugging instructions
(`doc/devdocs/modules/keystrokeoverlay.md`).
* Updated installer configuration to include Keystroke Overlay, adding
new WiX include and setup files (`installer/PowerToysSetup/Common.wxi`,
`installer/PowerToysSetup/KeystrokeOverlay.wxs`).
[[1]](diffhunk://#diff-ecd2ee19d18433ed47b8f13b44cfff7b00c8009c17bc71139cec0d8571f8f607R1-R59)
[[2]](diffhunk://#diff-af48b984b168acbe5aeb021e97a9e826ab9b52c20c08b36f40dd3e5ad00342b1R1-R9)
* Registered Keystroke Overlay in the settings documentation and issue
templates (`doc/dsc/Settings.md`,
`.github/ISSUE_TEMPLATE/bug_report.yml`,
`.github/ISSUE_TEMPLATE/translation_issue.yml`).
[[1]](diffhunk://#diff-bde46f469b76ba994ea938853f169553846221b329a21e9b59d37c5a0b7d63aeR35)
[[2]](diffhunk://#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efR85)
[[3]](diffhunk://#diff-135b470e9875068a1085599402d6f89bea163068568c426b22f493f35fbfbea6R58)
* Added KeystrokeOverlay binaries to the signing pipeline
(`.pipelines/ESRPSigning_core.json`).

**Customization options**
| Category | Setting | Description | Default / Example |
| :--- | :--- | :--- | :--- |
| **General** | **Enable Keystroke Overlay** | Master toggle to turn the
module on or off. | `On` |
| **Shortcuts** | **Activation Shortcut** | Hotkey to toggle the overlay
visibility. | `Win` + `Shift` + `K` |
| | **Switch Monitor Shortcut** | Hotkey to move the overlay to another
display. | `Win` + `Shift` + `/` |
| | **Switch Display Mode** | Hotkey to cycle through different
visualization modes. | `Win` + `Shift` + `D` |
| **Behavior** | **Draggable Overlay** | Allows you to manually move the
overlay position with your mouse. | `On` |
| | **Display Mode** | Controls what history of keys is shown (e.g.,
history vs. single). | `Last Five Keystrokes` |
| | **Overlay Timeout** | How long (in ms) the keys stay visible before
fading. | `2000` ms |
| **Appearance** | **Text Size** | Adjusts the font size of the keys
inside the overlay. | `37` |
| | **Text Color** | Sets the font color and transparency level. |
`White` (Example) |
| | **Background Color** | Sets the background box color and
transparency level. | `Purple` (Example) |

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
The new module was tested on multiple different Windows Devices and all
configurations work as expected.

---------

Signed-off-by: Shawn Yuan (from Dev Box) <shuaiyuan@microsoft.com>
Co-authored-by: Sátvik Karanam <89281036+skara9@users.noreply.github.com>
Co-authored-by: Jiří Polášek <me@jiripolasek.com>
Co-authored-by: Software2 <software-2@users.noreply.github.com>
Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Mike Griese <migrie@microsoft.com>
Co-authored-by: Jaylyn Barbee <51131738+Jaylyn-Barbee@users.noreply.github.com>
Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
Co-authored-by: Kai Tao <69313318+vanzue@users.noreply.github.com>
Co-authored-by: Mark Russinovich <markruss@microsoft.com>
Co-authored-by: Mark Russinovich <markruss@ntdev.microsoft.com>
Co-authored-by: Clint Rutkas <clint@rutkas.com>
Co-authored-by: Alex Mihaiuc <69110671+foxmsft@users.noreply.github.com>
Co-authored-by: Michael Jolley <mike@baldbeardedbuilder.com>
Co-authored-by: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Dave Rayment <dave.rayment@gmail.com>
Co-authored-by: Shawn Yuan <128874481+shuaiyuanxx@users.noreply.github.com>
Co-authored-by: Kai Tao <kaitao@microsoft.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jiripolasek <4773077+jiripolasek@users.noreply.github.com>
Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>
Co-authored-by: Sam Rueby <samrueby@gmail.com>
Co-authored-by: Lee Won Jun <dldnjs1013@nate.com>
Co-authored-by: Mason Bergstrom <13530957+MasonBergstrom@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Mike Hall <mikehall@microsoft.com>
Co-authored-by: moooyo <42196638+moooyo@users.noreply.github.com>
Co-authored-by: Yu Leng <yuleng@microsoft.com>
Co-authored-by: dsm20 <74568547+dsm20@users.noreply.github.com>
Co-authored-by: zackpaton <91792781+zackpaton@users.noreply.github.com>
Co-authored-by: Gleb Khmyznikov <gleb.khmyznikov@gmail.com>
Co-authored-by: Guilherme <57814418+DevLGuilherme@users.noreply.github.com>
2025-12-13 08:25:20 +01:00

135 lines
3.8 KiB
YAML

name: "🕷️ Bug report"
description: Report errors or unexpected behavior
labels:
- Issue-Bug
- Needs-Triage
body:
- type: markdown
attributes:
value: Please make sure to [search for existing issues](https://github.com/microsoft/PowerToys/issues) before filing a new one!
- type: markdown
attributes:
value: |
We are aware of the following high-volume issues and are actively working on them. Please check if your issue is one of these before filing a new bug report:
* **PowerToys Run crash related to "Desktop composition is disabled"**: This may appear as `COMException: 0x80263001`. For more details, see issue [#31226](https://github.com/microsoft/PowerToys/issues/31226).
* **PowerToys Run crash with `COMException (0xD0000701)`**: For more details, see issue [#30769](https://github.com/microsoft/PowerToys/issues/30769).
* **PowerToys Run crash with a "Cyclic reference" error**: This `System.InvalidOperationException` is detailed in issue [#36451](https://github.com/microsoft/PowerToys/issues/36451).
- id: version
type: input
attributes:
label: Microsoft PowerToys version
placeholder: X.XX.X
description: Hover over the system tray icon or look at Settings
validations:
required: true
- id: installed
type: dropdown
attributes:
label: Installation method
description: How / where was PowerToys installed from?
multiple: true
options:
- GitHub
- PowerToys auto-update
- Microsoft Store
- WinGet
- Chocolatey
- Scoop
- Dev build in Visual Studio
- Other (please specify in "Steps to Reproduce")
validations:
required: true
- type: dropdown
attributes:
label: Area(s) with issue?
description: What things had an issue? Check all that apply.
multiple: true
options:
- General
- Advanced Paste
- Always on Top
- Awake
- ColorPicker
- Command not found
- Command Palette
- Crop and Lock
- Environment Variables
- FancyZones
- FancyZones Editor
- File Locksmith
- "File Explorer: Preview Pane"
- "File Explorer: Thumbnail preview"
- Hosts File Editor
- Image Resizer
- Installer
- Keyboard Manager
- Light Switch
- Mouse Utilities
- Mouse Without Borders
- New+
- Peek
- PowerRename
- PowerToys Run
- Quick Accent
- Registry Preview
- Screen ruler
- Settings
- Shortcut Guide
- System tray interaction
- TextExtractor
- Workspaces
- Welcome / PowerToys Tour window
- ZoomIt
- Keystroke Overlay
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: We highly suggest including screenshots and a bug report log (System tray > Report bug).
placeholder: Having detailed steps helps us reproduce the bug.
validations:
required: true
- type: textarea
attributes:
label: ✔️ Expected Behavior
placeholder: What were you expecting?
validations:
required: false
- type: textarea
attributes:
label: ❌ Actual Behavior
placeholder: What happened instead?
validations:
required: false
- id: additionalInfo
type: textarea
attributes:
label: Additional Information
placeholder: |
OS version
.Net version
System Language
User or System Installation
Running as admin
validations:
required: false
- type: textarea
attributes:
label: Other Software
description: If you're reporting a bug about our interaction with other software, what software? What versions?
placeholder: |
vim 8.2 (inside WSL)
OpenSSH_for_Windows_8.1p1
My Cool Application v0.3 (include a code snippet if it would help!)
validations:
required: false