Skip to content
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

fix: correct key on shortcuts #1018

Merged
merged 1 commit into from
May 30, 2024
Merged

fix: correct key on shortcuts #1018

merged 1 commit into from
May 30, 2024

Conversation

cpvalente
Copy link
Owner

@cpvalente cpvalente commented May 29, 2024

  • fixes an issue with wrong arrow direction in shortcuts
  • fixes issues with using arrows instead of shift key

I have decided to spell out the keys rather than having symbols. I believe this makes it clearer even it it is more noisy (maybe)

Screenshot 2024-05-29 at 21 59 39

@lukestein what do you think?

@cpvalente cpvalente requested a review from alex-Arc May 29, 2024 19:56
Copy link
Contributor

coderabbitai bot commented May 29, 2024

Important

Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2)
  • apps/client/src/common/utils/deviceUtils.ts is excluded by none and included by none
  • apps/client/src/features/rundown/event-editor/EventEditorEmpty.tsx is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Tip

Early Access Features
  • gpt-4o model for chat

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@lukestein
Copy link
Collaborator

Personally, I prefer the symbols to the words

However, it seems like the old code was perhaps using the incorrect glyph for the shift key, which is why it looked particularly confusing with the arrows.

Up arrow should be (U+2191 Up Arrow)
Shift modifier should be (U+21E7 Upwards White Arrow)

@cpvalente
Copy link
Owner Author

seems like the old code was perhaps using the incorrect glyph for the shift key, which is why it looked particularly confusing with the

@lukestein
You are correct, this is what I was initially fixing.

I have tried using the shift key but the symbols seemed very similar to me
Screenshot 2024-05-29 at 22 23 36

What do you think?

@@ -3,6 +3,6 @@ export function isMacOS() {
return userAgent.includes('macintosh') || userAgent.includes('mac os');
}

export const deviceAlt = isMacOS() ? '⌥' : 'Alt';
export const deviceAlt = 'Alt';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

export const deviceAlt = isMacOS() ? 'Option' : 'Alt';

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thank you!

Copy link
Collaborator

@lukestein lukestein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mac refers to Alt key as "Option"

@lukestein
Copy link
Collaborator

Oh wow. Those shift symbols do render ugly in your screenshot. I note this is how Apple labels a keyboard shortcut with shift and an up arrow:
image

Text probably best in this case. But Mac calls it "option" not "Alt."

@cpvalente cpvalente merged commit ea3d33c into master May 30, 2024
3 checks passed
@cpvalente cpvalente deleted the ui-shortcuts branch May 30, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants