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

Add icons to Cmd Palette actions #115

Open
2 tasks
tyler-dane opened this issue Jul 28, 2024 · 3 comments
Open
2 tasks

Add icons to Cmd Palette actions #115

tyler-dane opened this issue Jul 28, 2024 · 3 comments
Labels
good first issue Good for newcomers

Comments

@tyler-dane
Copy link
Contributor

tyler-dane commented Jul 28, 2024

Context
Command palette support was added in #14 #102.

There are a few minor shortcomings with it, though:

  1. The tooltip text says, "Open command palette (CMD+k)".
    Although the text says 'CMD', the code actually uses [Meta Key] + k, where Meta Key is CMD on mac or WINDOWS KEY on windows. Without knowing that, however, Windows users might suspect that the command palette only works for mac users.
  2. The cmd palette wasn't tested on Windows
    I'm on Mac and have never tested that the command palette works on Windows.

Tasks

  • Update tooltip text so that it shows "{Cmd} + k" for mac users and "{Win} + k" for windows users*, where {Cmd} and {Win} refer to the icons

If you're a Windows user:

  • Test it works on Windows and post a comment here to confirm

Implementation Guidance
Update MetaKey.tsx
See icon prop in the react-cmdk ListItem API

@tyler-dane tyler-dane moved this to Todo in v1 Cleanup Jul 28, 2024
@tyler-dane tyler-dane changed the title Update cmd palette for Windows users Update cmd palette tooltip Jul 28, 2024
@tyler-dane
Copy link
Contributor Author

See the 'custom' section below for an example of how to use navigator.platform to accomplish this

https://github.com/albingroen/react-cmdk

@tyler-dane tyler-dane changed the title Update cmd palette tooltip Add icons to Cmd Palette actions Oct 20, 2024
@tyler-dane tyler-dane removed this from v1 Cleanup Dec 2, 2024
@tyler-dane tyler-dane moved this from Ready to Backlog in 🏗 Compass Roadmap Dec 6, 2024
@tyler-dane tyler-dane moved this from Backlog to Ready in 🏗 Compass Roadmap Dec 14, 2024
@MrPand-21
Copy link

Can take that one

@tyler-dane
Copy link
Contributor Author

Thanks for your willingness to help out, @MrPand-21. Unfortunately this is a Q4 issue, so it won't be worked on until September 2025 at the earliest. Please find an issue with the Q1 or Q2 milestone instead. I just created a new view to make that easier to do: https://github.com/orgs/SwitchbackTech/projects/4/views/8

Here is the updated workflow for picking up issues: https://docs.compasscalendar.com/docs/contribute/#workflows

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Ready
Development

No branches or pull requests

2 participants