# @accessible/use-key 中文文档
规范地址：https://npmcn.com/package/%40accessible/use-key/
版本：1\.0\.2
npm 元数据更新时间：2022-04-04T11:07:10.580Z
中文译文更新时间：2026-11-06T04:46:13.149Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40accessible/use-key
原文对照：https://npmcn.com/package/%40accessible/use-key/?lang=original
项目主页：https://github.com/accessible-ui/use-keycode#readme
源码仓库：https://github.com/accessible-ui/use-keycode
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：34.2 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react \>=16\.8
- 首次发布：2020-07-07T03:27:36.454Z
- 最新版本发布：2020-07-08T03:30:54.721Z
- 近 30 天下载量：5040（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）
## 中文简介
处理的反应钩 `keydown` 关于要素的活动
## 安装
```sh
npm install @accessible/use-key
```
也可以使用：`pnpm add @accessible/use-key`、`yarn add @accessible/use-key`、`bun add @accessible/use-key`
## README
* * *
# 使用 Key ()
[](https://bundlephobia.com/result?p=@accessible/use-key)[ ](https://codecov.io/gh/accessible-ui/use-key)[ ](https://travis-ci.org/accessible-ui/use-key)[ ](https://www.npmjs.com/package/@accessible/use-key)[](https://jaredlunde.mit-license.org/)
npm i @accessible/use-key
* * *
处理的反应钩 `keydown` 具体活动 `event.key` 数值。 还有 规范非标准 `event.key` 从IE到其现代等价值.
## 快速启动
```jsx
import * as React from 'react'
import useKey from '@accessible/use-key'
const Component = () => {
const ref = React.useRef(null)
// Listens to keydown events on the `ref` above
useKey(ref, {
// Logs event when the Escape key is pressed
Escape: console.log,
// Logs "Key was pressed: Enter" to the console when Enter is pressed
Enter: (event) => console.log('Key was pressed:', event.key),
})
// Listens to keydown events on the window
useKey(window, {
// Logs event when the Escape key is pressed
Escape: console.log,
// Logs "Key was pressed: Enter" to the console when Enter is pressed
Enter: (event) => console.log('Key was pressed:', event.key),
})
return
}
```
## API 密码
### 使用Key( 目标, 处理器)
#### 参数
| 参数 | 类型 | 需要吗? | 说明 |
| --- | --- | --- | --- |
| 目标 | `React.RefObject | T | Window | Document | null` | 对 | 反应参考,元素, `window`,或 `document` 添加密钥监听器到 |
| 处理者 | `Record any>` | 对 | 匹配密钥的映射 `event.key` 你想听的字符串。 每个密钥的值应为事件听众. |
#### 回返 `void`
## 自由主义
麻省理工学院
## 常见问题
### @accessible/use-key 是什么？
处理的反应钩 keydown 关于要素的活动
### 如何安装 @accessible/use-key？
在项目目录运行 npm install @accessible/use-key，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @accessible/use-key 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @accessible/use-key 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @accessible/use-key 可以商用吗？
@accessible/use-key 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @accessible/use-key 的下载量有多少？
根据 npm 官方下载统计，@accessible/use-key 在 2026/10/05 – 2026/11/03 这 30 天内被下载 5,040 次，日均约 168 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @accessible/use-key 还在维护吗？
最新版本 1\.0\.2 发布于 2020/07/08（6 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/07/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。