# @fluentui/keyboard-key 中文文档

规范地址：https://npmcn.com/package/%40fluentui/keyboard-key/

版本：0\.4\.23
npm 元数据更新时间：2026-07-24T19:28:01.670Z
中文译文更新时间：2026-11-15T01:24:42.141Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fluentui/keyboard-key
原文对照：https://npmcn.com/package/%40fluentui/keyboard-key/?lang=original
项目主页：https://github.com/microsoft/fluentui#readme
源码仓库：https://github.com/microsoft/fluentui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：144 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2020-03-17T12:25:43.204Z
- 最新版本发布：2024-06-24T07:31:13.933Z
- 近 30 天下载量：1095183（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 0 个）

## 中文简介

从键盘事件确定键盘Event.key属性的简单工具.

## 安装

```sh
npm install @fluentui/keyboard-key
```

也可以使用：`pnpm add @fluentui/keyboard-key`、`yarn add @fluentui/keyboard-key`、`bun add @fluentui/keyboard-key`

## README

# @ fluentui/ 键盘键

用于确定 `KeyboardEvent.key` 属性,来自键盘事件.

-   [安装](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-install)
-   [使用量](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-usage)
    -   [获取 Key ()](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-getkey)
    -   [获取Code ()](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-getcode)
-   [为什么?](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-why)
-   [地方洞穴](https://npmcn.com/package/%40fluentui/keyboard-key/#readme-locale-caveat)

## 安装

```
yarn add keyboard-key

# or

npm install keyboard-key
```

## 使用量

### 获取 Key ()

拿着 `key` 属性值.

```js
document.addEventListener('keydown', event => {
  const key = keyboardKey.getKey(event);

  switch (key) {
    case 'Escape':
      // handle escape key
      break;
    default:
      break;
  }
});
```

> 见 [MDN 数据](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) 或完整列表的来源 `key` 数值.

### 获取Code ()

你也可以得到正常化的 `keyCode` 从一个事件. `@fluentui/keyboard-key` 包括散列 `key` 名称改为 `keyCode`s 用于比较:

```js
document.addEventListener('keydown', event => {
  const code = getCode(event);

  switch (code) {
    case keyboardKey.Escape: // 27
      // handle escape key
      break;
    default:
      break;
  }
});
```

## 为什么?

之前大多数键盘标识键盘Event 属性已被按下, 已贬值为赞成 `Keyboard.key`。 。 。 .

: 1 个: `KeyboardEvent.char` : 1 个: `KeyboardEvent.charCode` : 1 个: `KeyboardEvent.keyCode` : 1 个: `KeyboardEvent.keyIdentifier` : 1 个: `KeyboardEvent.keyLocation` : 1 个: `KeyboardEvent.which`

:+1 : `KeyboardEvent.key`

很遗憾, `KeyboardEvent.key` 尚未达到 [浏览器支持](http://caniuse.com/#feat=keyboardevent-key)。让浏览器没有可靠的属性来识别键盘事件键.

## 地方洞穴

此工具在推断事件时解释移位键的使用 `key` 数值。 示例,描述事件 调动\+ 键编号 : 将会导致 `key` 价值 ? 吗?。这个逻辑假设 `en-US` 地方键盘布局. 这个会 **没有工作** 如果您正在使用德国版式等不同地方 编号 : 实值 调动\+ 键第7条。 。 。 .

## 常见问题

### @fluentui/keyboard-key 是什么？

从键盘事件确定键盘Event\.key属性的简单工具\.

### 如何安装 @fluentui/keyboard-key？

在项目目录运行 npm install @fluentui/keyboard-key，或使用 pnpm add / yarn add / bun add。

### @fluentui/keyboard-key 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fluentui/keyboard-key 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @fluentui/keyboard-key 可以商用吗？

@fluentui/keyboard-key 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fluentui/keyboard-key 的下载量有多少？

根据 npm 官方下载统计，@fluentui/keyboard-key 在 2026/10/15 – 2026/11/13 这 30 天内被下载 1,095,183 次，日均约 36,506 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fluentui/keyboard-key 还在维护吗？

最新版本 0\.4\.23 发布于 2024/06/24（2 年前）；至今共发布 56 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/03/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。