palantir/blueprint

Document `KeyComboTag` component

Open

#1,954 opened on Dec 21, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (2,167 forks)batch import
Domain: documentationP2Package: corehelp wanted

Repository metrics

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

Description

Hey there,

In blueprint's HotkeyDialog we see these pretty hotkeys:

image

I'm wondering if the code that makes those nice looking image icons in a mac/windows specific was is exported as a function somewhere?

I looked in the docs but did not seem to see it something to do it. Ideally I would be able to do something like <div> {generateHotkeyIcon("meta+c")} </div>

Hope that makes sense. Thanks!

Contributor guide

Research direction
Check the current documentation for KeyComboTag and identify if the hotkey icon utility function is private. Propose to export it and document its usage.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75