palantir/blueprint

Document `KeyComboTag` component

Open

#1 954 ouverte le 21 déc. 2017

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)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!

Guide contributeur

Stack technique
typescriptreact
Domaine
frontenddocumentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
ReactTypeScriptBlueprint library basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.