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 (20,263 stars) (2,167 forks)batch import
P2Package: coreType: bughelp wanted

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

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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptHotkey component structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the Hotkey component's key normalization logic, likely in the source files under packages/core/src/components/hotkey. Find where 'mod' is mapped to 'cmd' or 'ctrl' based on OS. Replicate that pattern to map 'option' to display 'option' on macOS and 'alt' on other platforms. Check existing tests for the component to ensure the change is covered and does not break existing behavior.
Hotkey should show "option" text on macOS instead of "alt" · palantir/blueprint#4959 | Good First Issue