Skip to content

Kbd 键盘按键

语义化的 <kbd> 封装组件,通过新粗野主义样式将快捷键从普通文本中视觉剥离,让文档和命令提示一目了然。

预览

Preview

常用快捷键

+K打开命令面板
Ctrl+S保存
Shift+Tab反向缩进

尺寸

EscEnterSpace

变体

EscEnterTabSpace

安装

pnpm dlx brutx-vue@latest add kbd

用法

vue
<script setup>
import { Kbd } from 'brutx-ui-vue'
</script>

<template>
    <!-- 单键 -->
    <Kbd>Enter</Kbd>

    <!-- 组合键 -->
    <div class="flex items-center gap-1">
        <Kbd>⌘</Kbd>
        <span>+</span>
        <Kbd>K</Kbd>
    </div>

    <!-- 尺寸 -->
    <Kbd size="sm">Esc</Kbd>
    <Kbd size="md">Tab</Kbd>
    <Kbd size="lg">Space</Kbd>
</template>

变体

变体说明
default中性背景,标准前景色文字
primaryPrimary(珊瑚色)背景,高对比前景色
secondarySecondary(薄荷青)背景
accentAccent(黄色)背景
vue
<script setup>
import { Kbd } from 'brutx-ui-vue'
</script>

<template>
    <div class="flex items-center gap-2">
        <Kbd variant="default">Esc</Kbd>
        <Kbd variant="primary">Enter</Kbd>
        <Kbd variant="secondary">Tab</Kbd>
        <Kbd variant="accent">Space</Kbd>
    </div>
</template>

尺寸

尺寸说明
sm小尺寸,适合内联紧凑场景
md默认尺寸
lg大尺寸,适合独立展示

Props

属性类型默认值说明
variant'default' | 'primary' | 'secondary' | 'accent''default'按键颜色变体
size'sm' | 'md' | 'lg''md'按键尺寸
classstring | undefinedundefined自定义样式类,会与组件默认样式合并

插槽

插槽作用域说明
default按键内容(文字或符号)

可访问性

  • 语义化标记:使用原生 <kbd> 元素渲染,屏幕阅读器可正确识别为键盘按键
  • 视觉呈现:通过粗野主义样式将按键从普通文本中视觉剥离,提升可读性
  • 组合键展示:支持通过多个 <Kbd> 组合展示快捷键,语义清晰

蛮力铸就。