---
title: Kbd
description: 显示键盘按键的标记
category: Basic
status: beta
since: 0.3.7
tags: [keyboard, shortcut, token]
syncStatus: reviewed
verified: true
---

## 用法

### 快捷键
::::TuffDemoWrapper{demo="KbdKbdDemo" code-lang="vue"}
---
code: |
  <template>
    <TxKbd tone="primary">⌘</TxKbd>
    <TxKbd tone="primary">K</TxKbd>
  </template>
---
::::

### 最佳实践

- 组合键拆成多个 `TxKbd`，不要用一个长字符串。
- 键名随平台变化：macOS 用 `⌘`，Windows / Linux 用 `Ctrl`。
- `tone="primary"` 只用于页面或命令的主快捷键，同屏不超过一组。
- 快捷键旁配可见的操作文案，单独出现不易被发现。

## API 参考

### 属性

| 属性名 | 类型 | 默认值 | 说明 |
|------|------|---------|------|
| `size` | `'sm' \| 'md'` | `'sm'` | `sm` 用于行内帮助与菜单快捷键，`md` 用于单独展示的快捷键。 |
| `tone` | `'default' \| 'primary'` | `'default'` | `primary` 突出主快捷键。 |

### 插槽

| 插槽名 | Props | 说明 |
|------|------|------|
| `default` | - | 键位文本，如 `⌘`、`Ctrl` 或 `K`。 |

## 概述

- 根节点是原生 `<kbd>`。
- 只渲染默认插槽，没有内部状态。
- `tone="primary"` 只改变外观，不改动插槽文本。

## 技术实现

- 源码：`packages/tuffex/packages/components/src/kbd/`。

<TuffDocSourceLink />
