feat: add mouse tracking to KeyStrokeListener
#210
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
PR Overview
This pull request adds mouse tracking support to the keystroke listener utility while updating related documentation and navigation examples. The key changes include:
- Updating the keystroke listener docs to cover mouse events, including examples and a demo.
- Modifying the VitePress navigation to reposition the "Text styling" link under the "Components" section.
- Adjusting the image path in the text-styling documentation.
Reviewed Changes
| File | Description |
|---|---|
| docs/content/utilities/keystroke-listener.md | Adds documentation for mouse events and examples for mouse tracking. |
| docs/.vitepress/config.mjs | Updates navigation by moving the text styling link under Components. |
| docs/content/utilities/text-styling.md | Fixes the image path for the text styling documentation. |
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
docs/content/utilities/keystroke-listener.md:14
- The PR description indicates a rename from
KeyStrokeListenertoTerminalEventListener. Please update the documentation references if the renaming is finalized.
You can listen for both printable characters and special keys using the `KeyStrokeListener`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
KeyStrokeListener/KeyStroketoTerminalEventListener/TerminalEventKeyStrokeListenerwithMouseTrackingtoTerminalto enable mouse tracking / mouse motion trackingKeyStrokeListenerTeststo test characters/special keys/mouse events are decoded properlyKeyStrokeListenerdocs describing how to listen for mouse eventsmouse-trackingtoexamples-cliwith a demo showcasing mouse tracking (click and drag to draw). I wasn't sure if this should be included as an example since it does not showcase a specific component, but I think it's a good example demoingKeyStrokeListener. Happy to remove though.A future PR can add mouse support to the existing components (click yes/no, select option from list with mouse)
CleanShot.2025-02-25.at.22.01.33.mp4