-
Notifications
You must be signed in to change notification settings - Fork 208
fix(ui): Fix reference guide key hint for PC #782
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,41 @@ | ||
| import { cn } from '@/lib/utils' | ||
| import React from 'react' | ||
| 'use client'; | ||
|
|
||
| import { cn, IS_MAC } from '@/lib/utils' | ||
| import React, { useMemo } from 'react' | ||
|
|
||
| interface KeyboardShortcutHintProps { | ||
| shortcut: string | ||
| label?: string | ||
| className?: string | ||
| } | ||
|
|
||
| /** | ||
| * Converts Mac-specific keyboard shortcuts to platform-appropriate shortcuts. | ||
| * On Mac: displays the shortcut as-is (e.g., "⌘") | ||
| * On Windows/Linux: replaces "⌘" with "Ctrl" | ||
| */ | ||
| function getPlatformShortcut(shortcut: string): string { | ||
| if (IS_MAC) { | ||
| return shortcut; | ||
| } | ||
| // Replace Mac Command key symbol with Ctrl for non-Mac platforms | ||
| return shortcut.replace(/⌘/g, 'Ctrl'); | ||
| } | ||
|
|
||
| export function KeyboardShortcutHint({ shortcut, label, className }: KeyboardShortcutHintProps) { | ||
| return ( | ||
| <div className={cn("inline-flex items-center", className)} aria-label={label || `Keyboard shortcut: ${shortcut}`}> | ||
| <kbd | ||
| className="px-2 py-1 font-semibold font-sans border rounded-md" | ||
| style={{ | ||
| fontSize: "0.65rem", | ||
| lineHeight: "0.875rem", | ||
| }} | ||
| > | ||
| {shortcut} | ||
| </kbd> | ||
| </div> | ||
| ) | ||
| const platformShortcut = useMemo(() => getPlatformShortcut(shortcut), [shortcut]); | ||
|
|
||
| return ( | ||
| <div className={cn("inline-flex items-center", className)} aria-label={label || `Keyboard shortcut: ${platformShortcut}`}> | ||
| <kbd | ||
| className="px-2 py-1 font-semibold font-sans border rounded-md" | ||
| style={{ | ||
| fontSize: "0.65rem", | ||
| lineHeight: "0.875rem", | ||
| }} | ||
| > | ||
| {platformShortcut} | ||
| </kbd> | ||
| </div> | ||
| ) | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@msukkari we probably want mapping for ⌥ and ^ as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can spin up another PR to replace all of them, because it looks like ⌘ is referenced in a lot of other places too. Just to sanity check ⌘ == ctrl, ⌥ == alt in Sourcebot?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i.e. is the actual logic mapping for the key correct in Sourcebot for PC or does that need to be fixed too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would look at https://www.npmjs.com/package/react-hotkeys-hook to see what mapping it uses
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think an improvement here would actually to just take whatever format react-hotkeys expects in KeyboardShortcutHint and translate that into what we display in the shortcut. I believe every KeyboardShortcutHint will be paired with a useHotkeys, so it probably makes sense to make it consistent and share the same hotkey as a variable s.t., we avoid running into situations where the hint and the actual hotkey do not match.