palantir/blueprint

Document `KeyComboTag` component

Open

#1,954 opened on Dec 21, 2017

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

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

Tech stack
typescriptreact
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
ReactTypeScriptBlueprint library basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the Blueprint documentation structure, likely in a 'docs' folder or website. Find the KeyComboTag component source (e.g., packages/core/src/components/hotkeys/keyComboTag.tsx). Check if a function like generateHotkeyIcon is already exported. Then write a documentation page similar to other components, explaining usage, props, and platform specific rendering.