C

KeyboardShortcut 键盘快捷键

通用基础组件

键盘快捷键 — Chaos UI 的通用基础组件。

何时使用

需要键盘快捷键功能时使用本组件。

代码示例

基础用法

tsx
import { KeyboardShortcut } from "@/components/ui/keyboard-shortcut"

export function Basic() {
return <KeyboardShortcut>Default</KeyboardShortcut>
}

尺寸

tsx
{/* 尺寸对照 */}
<div className="flex flex-wrap items-center gap-3">
<KeyboardShortcut size="sm">Sm</KeyboardShortcut>
<KeyboardShortcut size="default">Default</KeyboardShortcut>
<KeyboardShortcut size="lg">Lg</KeyboardShortcut>
</div>

样式变体

尺寸

Size说明默认
default默认尺寸
sm小号
lg大号

API / Props

KeyboardShortcut

PropTypeDefault说明
classNamestring自定义样式类名
keysstring | string[]The keys to display
separatorstring+Separator between keys
...restReact.ComponentProps<"kbd">透传 <kbd> 原生属性

注意事项

  • CVA 变体: 通过 class-variance-authority 管理样式变体,类型安全。变体对象可导出复用。
  • 原生属性: 继承所有 <kbd> 原生 HTML 属性。

📘 完整交互式示例与控件属性请查看 Storybook 文档