palantir/blueprint

Document `KeyComboTag` component

Open

#1.954 geöffnet am 21. Dez. 2017

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (20.263 Stars) (2.167 Forks)batch import
Domain: documentationP2Package: corehelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
ReactTypeScriptBlueprint library basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.