palantir/blueprint

Document `KeyComboTag` component

Open

#1,954 创建于 2017年12月21日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)TypeScript (20,263 star) (2,167 fork)batch import
Domain: documentationP2Package: corehelp wanted

描述

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!

贡献者指南

技术栈
typescriptreact
领域
frontenddocumentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
ReactTypeScriptBlueprint library basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.