# @convertkit/slate-keymap 中文文档

规范地址：https://npmcn.com/package/%40convertkit/slate-keymap/

版本：0\.1\.10
npm 元数据更新时间：2026-10-02T06:36:52.565Z
中文译文更新时间：2026-11-10T18:13:14.400Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40convertkit/slate-keymap
原文对照：https://npmcn.com/package/%40convertkit/slate-keymap/?lang=original

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

- 包体积（解压后）：18.1 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：react ^16\.4\.0，slate ^0\.44\.0，immutable ^3\.8\.2，react-dom ^16\.4\.0，slate-react ^0\.21\.0
- 首次发布：2019-01-22T13:03:09.431Z
- 最新版本发布：2020-04-10T14:26:39.882Z
- 近 30 天下载量：5299（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

简化键盘快捷键的 Slate 插件

## 安装

```sh
npm install @convertkit/slate-keymap
```

也可以使用：`pnpm add @convertkit/slate-keymap`、`yarn add @convertkit/slate-keymap`、`bun add @convertkit/slate-keymap`

## README

# 模板键盘图

![](https://img.shields.io/circleci/project/github/ConvertKit/slate-plugins/master.svg?style=flat)

[在 Github 上的视图](https://github.com/ConvertKit/slate-plugins)

用 SlateJS 简化键盘快捷键的插件 . `slate-keymap` 用途 `is-hotkey` 在引擎盖下检查某一事件是否匹配所配置的密钥.

## 安装

```sh
yarn add @convertkit/slate-keymap
```

## 使用量

`Keymap(object: Object, options: Object)`

### 示例

```javascript
import Keymap from "@convertkit/slate-keymap";

const plugins = [
  Keymap({
    "mod+a": (event, editor) => editor.selectAll(),
    // You can also pass a string and it will call the command with that name
    "shift+enter": "softBreak"
  })
];
```

### 选项

-   `if`: 传递函数 `editor` 举个例子 如果还是真的, 然后 Keymap 活动。 默认为 `() => true`

## 常见问题

### @convertkit/slate-keymap 是什么？

简化键盘快捷键的 Slate 插件

### 如何安装 @convertkit/slate-keymap？

在项目目录运行 npm install @convertkit/slate-keymap，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.4\.0）、slate（^0\.44\.0）、immutable（^3\.8\.2）、react-dom（^16\.4\.0）、slate-react（^0\.21\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @convertkit/slate-keymap 支持 TypeScript 吗？

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

### @convertkit/slate-keymap 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @convertkit/slate-keymap 可以商用吗？

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

### @convertkit/slate-keymap 的下载量有多少？

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

### @convertkit/slate-keymap 还在维护吗？

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