# @codexteam/shortcuts 中文文档

规范地址：https://npmcn.com/package/%40codexteam/shortcuts/

版本：1\.2\.0
npm 元数据更新时间：2022-09-14T12:17:49.490Z
中文译文更新时间：2026-11-10T08:29:07.565Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：17.6 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2018-02-13T05:30:50.173Z
- 最新版本发布：2022-08-04T16:48:19.730Z
- 近 30 天下载量：7649（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

处理键盘快捷键的库

## 安装

```sh
npm install @codexteam/shortcuts
```

也可以使用：`pnpm add @codexteam/shortcuts`、`yarn add @codexteam/shortcuts`、`bun add @codexteam/shortcuts`

## README

# 代码X 快捷键

CodeX快捷键是用于在Javascript中发送键盘快捷键的微图书馆. 你不需要外部依赖.

## 安装

关于国家预防机制的成套资料

```
npm install @codexteam/shortcuts --save
```

## 使用量

如果使用Webpack或ES6,则需要模块

```javascript
const Shortcut = require('@codexteam/shortcuts');
```

或者说

```javascript
import Shortcut from '@codexteam/shortcuts'
```

### 创建快捷键

作为类提供的库,以创建新的快捷键,制作一个 `Shortcut` 选项.

示例

```javascript
let cmdA = new Shortcut({
    name : 'CMD+A',
    on : document.body,
    callback: function(event) {
        // your handler
    }
});
```

`name` - 这是快捷键名称,密钥必须用 `+`

`on` - 绑定的元素。 快捷键只会被传递的( 此) 元素所射击

`callback` - 您的代码定义行为

如果您有单页网页应用程序, 不需要快捷键处理器 你可以轻易取出

```javascript
cmdA.remove();
```

## 如何运作

库解析给构造器上的数据,定义命令和密钥.

支持的命令 : `shift`, (中文(简体) ), `cmd`, (中文(简体) ), `command`, (中文(简体) ), `ctrl`, (中文(简体) ), `control`, (中文(简体) ), `windows`, (中文(简体) ), `alt`。 。 。 .

换句话说,我们通过 键和特殊命令。 特殊命令有: `backspace`, (中文(简体) ), `enter`, (中文(简体) ), `right`, (中文(简体) ), `left`, (中文(简体) ), `up`, (中文(简体) ), `down`, (中文(简体) ), `escape`, (中文(简体) ), `insert`, (中文(简体) ), `delete`。 。 。 .

## 捐款

要贡献,请叉子,请为它添加补丁和测试(在测试/文件夹中)并提交拉出请求.

CodeX是一个由热爱网络开发,设计和营销的热情人士组成的团队.  
我们在世界地区建立一个价值很高的项目.

请给我们回馈 [团队@ifmo.su](https://npmcn.com/package/%40codexteam/shortcuts/team@ifmo.su)

跟着我们:

VK : (韩语) [https://vk.com/codex team (中文(简体) )](https://vk.com/codex_team)

电报 : [https://t.me/codex team (中文(简体) )](https://t.me/codex_team)

内存 : [https://www.instagram.com/codex team (中文(简体) )](https://www.instagram.com/codex_team)

## 常见问题

### @codexteam/shortcuts 是什么？

处理键盘快捷键的库

### 如何安装 @codexteam/shortcuts？

在项目目录运行 npm install @codexteam/shortcuts，或使用 pnpm add / yarn add / bun add。

### @codexteam/shortcuts 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/codexteam\_\_shortcuts 是否存在。

### @codexteam/shortcuts 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codexteam/shortcuts 可以商用吗？

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

### @codexteam/shortcuts 的下载量有多少？

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

### @codexteam/shortcuts 还在维护吗？

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