@danharrin/alpine-mousetrap

中文文档
0.1.11发布于 2026/11/07MITES Module零依赖近 30 天下载 2万

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

中文使用文档
文档目录9 节
  1. 关于
  2. 安装
  3. 光盘N
  4. 国家预防机制
  5. 使用量
  6. 全球约束
  7. 斜线 (/)
  8. 版本
  9. 许可证

帮助支持维护此软件包 赞助我。 。 。 .

Alpine.js 鼠标陷阱

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

GitHub tag (latest by date) Monthly downloads via CDN

关于

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

安装

光盘N

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

<script src="https://cdn.jsdelivr.net/npm/@danharrin/[email protected]/dist/alpine-mousetrap.js" defer></script>

国家预防机制

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

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

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

Alpine.plugin(Mousetrap)

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

使用量

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

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

看看原来的 鼠标陷阱 文档,以获取更多快捷方式.

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

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

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

全球约束

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

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

斜线 (/)

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

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

版本

本项目遵循 语义版本 准则.

许可证

版权(c) Dan Harrin

麻省理工学院颁发的执照,见 利比里亚 详细情况.

版本与发布记录

@danharrin/alpine-mousetrap 共发布 12 个版本,首次发布于 2022/05/05;过去 12 个月发布了 3 个版本。

版本发布日期距今
0.1.11latest2026/11/073 天前
0.1.102026/08/302 个月前
0.1.92025/11/2811 个月前
0.1.82025/10/041.1 年前
0.1.72025/03/201.6 年前
0.1.62024/05/152 年前

关于 @danharrin/alpine-mousetrap 的常见问题

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