JGuang

快捷键标记

Kbd · Chakra UI

交互预览
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

快捷键标记

显示键盘按键或组合键,不会自动注册快捷键。按平台使用正确修饰键名称,实际快捷键处理需避免覆盖浏览器和输入框常用操作。

安装与初始化

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包,不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南;npm 安装之外还需单独复制所选示例源码。

完整原生使用示例

这是固定版本的真实示例,不是通用 API 伪代码。复制完整源码依赖并保留命名导出;附加依赖逐例列在下方。

import { Kbd } from "@chakra-ui/react"

export const KbdBasic = () => {
  return <Kbd>Shift + Tab</Kbd>
}

全部示例与复现要求

示例名称用于选择演示,不是组件通用 variant 属性。复制所选示例全部 sourceFiles;compositions 别名表示本地文件,不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查;编辑器示例保留一致的固定 Tiptap 扩展版本。

基础用法

kbd-basic · 命名导出 KbdBasic · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-basic.tsx

组合

kbd-with-combinations · 命名导出 KbdWithCombinations · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-with-combinations.tsx

功能按键

kbd-function-keys · 命名导出 KbdFunctionKeys · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-function-keys.tsx

不同变体

kbd-with-variants · 命名导出 KbdWithVariants · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-with-variants.tsx

不同尺寸

kbd-with-sizes · 命名导出 KbdWithSizes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-with-sizes.tsx

内部文本

kbd-within-text · 命名导出 KbdWithinText · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/kbd-within-text.tsx

原生 API 与源码参考

源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准;本指南不平铺或编造默认值。代码注释保留原文,不冒充正文翻译。

  • npm/@chakra-ui/react@3.37.0/dist/types/components/kbd/index.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/kbd/kbd.d.ts

状态与安装后检查

执行严格类型检查、目标项目生产构建和实际操作。检查名称/焦点/键盘、深浅色、窄屏、原生支持的空/加载/错误状态以及卸载清理。预览限制远程接口、上传与下载,业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。

来源与许可边界

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

本页是 JGuang 双语实用说明,不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明;原始许可元数据差异与缺失完整声明仍作为显式审查事项,不包含 Chakra Pro 付费内容。