compass icon indicating copy to clipboard operation
compass copied to clipboard

Update Cmd palette icon based on user's OS

Open tyler-dane opened this issue 1 year ago • 4 comments

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 avatar Jul 28 '24 17:07 tyler-dane

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 avatar Oct 01 '24 12:10 tyler-dane

Can take that one

MrPand-21 avatar Jan 24 '25 19:01 MrPand-21

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

tyler-dane avatar Jan 25 '25 13:01 tyler-dane

Title is a little misleading, since the Cmd Palette actions already have icons. Will update the title based on the description of the ticket.

that-one-arab avatar Mar 21 '25 23:03 that-one-arab

Hey! I’m a full stack dev comfortable with React and TypeScript. I use both Windows and macOS, so I can handle updating the tooltip icon and verify the behavior on both systems. I can get it done in the next 24–48 hours.

sonkiee avatar May 29 '25 03:05 sonkiee

@sonkiee Sure! All yours.

that-one-arab avatar May 29 '25 06:05 that-one-arab

Unassigning and moving back to Ready due to inactivity

tyler-dane avatar Jun 06 '25 12:06 tyler-dane

I can try this one if it's available!

fogboots avatar Jun 21 '25 06:06 fogboots

@fogboots Sounds good, just submit a PR whenever it's ready!

Since you're a new contributor, we will NOT assign the issue to you before a PR is submitted. This helps us avoid holding an issue for an extended period of time.

https://docs.compasscalendar.com/docs/contribute/

CC @that-one-arab

tyler-dane avatar Jun 21 '25 10:06 tyler-dane

closed in https://github.com/SwitchbackTech/compass/pull/547

that-one-arab avatar Jun 22 '25 02:06 that-one-arab