# @danharrin/alpine-mousetrap 中文文档

规范地址：https://npmcn.com/package/%40danharrin/alpine-mousetrap/

版本：0\.1\.11
npm 元数据更新时间：2026-11-07T11:22:06.332Z
中文译文更新时间：2026-11-11T10:07:40.126Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：82.9 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2022-05-04T18:35:28.022Z
- 最新版本发布：2026-11-07T11:22:06.177Z
- 近 30 天下载量：19647（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 3 个）

## 中文简介

一个简单的库,用来处理与Alpine.js的键盘快捷键.

## 安装

```sh
npm install @danharrin/alpine-mousetrap
```

也可以使用：`pnpm add @danharrin/alpine-mousetrap`、`yarn add @danharrin/alpine-mousetrap`、`bun add @danharrin/alpine-mousetrap`

## README

> 帮助支持维护此软件包 [赞助我](https://github.com/sponsors/danharrin)。 。 。 .

# Alpine.js 鼠标陷阱

一个简单的库,用来处理与Alpine.js的键盘快捷键.

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/danharrin/alpine-mousetrap?label=version&style=flat-square) [![Monthly downloads via CDN](https://data.jsdelivr.com/v1/package/npm/@danharrin/alpine-mousetrap/badge)](https://www.jsdelivr.com/package/npm/@danharrin/alpine-mousetrap)

## 关于

此插件添加了一个新的 `x-mousetrap` 指示您所有可用于注册键盘快捷键的高山元件 .

## 安装

### 光盘N

包括以下内容: `<script>` 标记在 `<head>` 在阿尔卑斯山之前.

```html
<script src="https://cdn.jsdelivr.net/npm/@danharrin/alpine-mousetrap@0.x.x/dist/alpine-mousetrap.js" defer></script>
```

### 国家预防机制

```bash
npm install @danharrin/alpine-mousetrap --save-dev
```

添加数据 `x-mousetrap` 通过导入软件包对您的工程进行指令 **在此之前** 阿尔平.js.

```js
import Alpine from 'alpinejs'
import Mousetrap from '@danharrin/alpine-mousetrap'

Alpine.plugin(Mousetrap)

window.Alpine = Alpine
window.Alpine.start()
```

## 使用量

要注册按钮或其他可点击元素的键盘快捷键:

```html
<div x-data="{}">
    <button
        type="button"
        x-mousetrap.command-k.ctrl-k
    >
        Button
    </button>
</div>
```

看看原来的 [鼠标陷阱](https://github.com/ccampbell/mousetrap) 文档,以获取更多快捷方式.

如果快捷键使用 `+`,替换为 a `-`如果快捷键是一个序列,则以 `--`。如果您要注册一个以上的快捷键,请将它们分出一段时间.

也可以在键盘快捷键被击中时引用自定义函数:

```html
<div x-data="{}">
    <button
        type="button"
        x-mousetrap.command-k.ctrl-k="console.log('command k or control k')"
    >
        Button
    </button>
</div>
```

### 全球约束

您可以聆听“ 全球” 键盘事件, 可以在任何地方工作, 包括内部输入字段:

```html
<div x-data="{}">
    <button
        type="button"
        x-mousetrap.global.command-k.ctrl-k
    >
        Button
    </button>
</div>
```

### 斜线 (/)

您可以使用关键词"slash"收听按键事件 :

```html
<div x-data="{}">
    <button
        type="button"
        x-mousetrap.global.slash
    >
        Button
    </button>
</div>
```

## 版本

本项目遵循 [语义版本](https://semver.org/) 准则.

## 许可证

版权(c) Dan Harrin

麻省理工学院颁发的执照,见 [利比里亚](https://npmcn.com/package/%40danharrin/alpine-mousetrap/LICENSE.md) 详细情况.

## 常见问题

### @danharrin/alpine-mousetrap 是什么？

一个简单的库,用来处理与Alpine\.js的键盘快捷键\.

### 如何安装 @danharrin/alpine-mousetrap？

在项目目录运行 npm install @danharrin/alpine-mousetrap，或使用 pnpm add / yarn add / bun add。

### @danharrin/alpine-mousetrap 支持 TypeScript 吗？

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

### @danharrin/alpine-mousetrap 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @danharrin/alpine-mousetrap 可以商用吗？

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

### @danharrin/alpine-mousetrap 的下载量有多少？

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

### @danharrin/alpine-mousetrap 还在维护吗？

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