@accessible/use-key

中文文档
1.0.2发布于 2020/07/08MITTypeScriptESM + CJS近 30 天下载 5040

处理的反应钩 keydown 关于要素的活动

中文使用文档
文档目录4 节
  1. 快速启动
  2. API 密码
  3. 使用Key( 目标, 处理器)
  4. 自由主义

使用 Key ()

Bundlephobia Code coverage Build status NPM Version MIT License

npm i @accessible/use-key

处理的反应钩 keydown 具体活动 event.key 数值。 还有 规范非标准 event.key 从IE到其现代等价值.

快速启动

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 <div ref={ref} />
}

API 密码

使用Key( 目标, 处理器)

参数

参数类型需要吗?说明
目标React.RefObject<T> | T | Window | Document | null对反应参考,元素, window,或 document 添加密钥监听器到
处理者Record<string, (event?: KeyboardEvent) => any>对匹配密钥的映射 event.key 你想听的字符串。 每个密钥的值应为事件听众.

回返 void

自由主义

麻省理工学院

版本与发布记录

@accessible/use-key 共发布 3 个版本,首次发布于 2020/07/07;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.2latest2020/07/086 年前
1.0.12020/07/086 年前
1.0.02020/07/076 年前

关于 @accessible/use-key 的常见问题

@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 和提交记录判断。