palantir/blueprint

Hotkey should show "option" text on macOS instead of "alt"

Open

#4,959 opened on Oct 7, 2021

View on GitHub
 (0 comments) (3 reactions) (0 assignees)TypeScript (2,167 forks)batch import
P2Package: coreType: bughelp wanted

Repository metrics

Stars
 (20,263 stars)
PR merge metrics
 (Avg merge 43d 10h) (27 merged PRs in 30d)

Description

Environment

  • Package version(s): blueprintjs core v3.51.0
  • Browser and OS versions: All browsers; macOS

Feature request

The text for Hotkey when combo has the word "option" should display "option" as the associated text on macOS instead of "alt". This is similar to how "mod" is "cmd" or "ctrl" depending on the operating system.

Examples

<Hotkey
    global
    combo="option"
    label="Test"
    preventDefault
    onKeyDown={() => console.log('test')}
/>

Currently, it automatically renames "option" to "alt" when passed into combo:

Should be:

Contributor guide

Research direction
Investigate the Hotkey component's key mapping logic, specifically how it translates 'option' to 'alt'. Find where the display text is set and add macOS detection to show 'option' instead.
Tech stack
typescriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitReactTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75