# @bpmn-io/feelers-editor 中文文档

规范地址：https://npmcn.com/package/%40bpmn-io/feelers-editor/

版本：1\.2\.0
npm 元数据更新时间：2026-09-01T13:04:01.341Z
中文译文更新时间：2026-11-08T13:06:30.380Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：124 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：14 个
- 首次发布：2026-06-24T10:23:34.166Z
- 最新版本发布：2026-09-01T13:04:01.003Z
- 近 30 天下载量：128281（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

以 CodeMiror 6 为基础的感官编辑器组件.

## 安装

```sh
npm install @bpmn-io/feelers-editor
```

也可以使用：`pnpm add @bpmn-io/feelers-editor`、`yarn add @bpmn-io/feelers-editor`、`bun add @bpmn-io/feelers-editor`

## README

# @bpmn-io/ feelers-编辑器

[![CI](https://github.com/bpmn-io/feelers/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/feelers/actions/workflows/CI.yml)

[代码 6](https://codemirror.net/) 编辑器组件 [感觉者](https://github.com/bpmn-io/feelers) 调伏语言.

![feelers editor - light theme](https://npmcn.com/package/%40bpmn-io/feelers-editor/docs/editor-light.png) ![feelers editor - dark theme](https://npmcn.com/package/%40bpmn-io/feelers-editor/docs/editor-dark.png)

## 使用量

```js
import { FeelersEditor } from '@bpmn-io/feelers-editor';

const editor = new FeelersEditor({
  container: document.querySelector('#editor'),
  value: 'Hello {{name}}!',
  onChange: (value) => console.log(value)
});
```

### 配置

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `container` | `Element` | 包含编辑器的 DOM 节点 |
| `value` | `string` | 初始内容 |
| `onChange` | `Function` | 内容更改时调用 |
| `onKeyDown` | `Function` | 调用按键事件 |
| `onLint` | `Function` | 可用内嵌信件时调用 |
| `hostLanguage` | `string` | 主机语言(如:. `'markdown'`(中文(简体) ) |
| `hostLanguageParser` | `Parser` | 自定义主机语言的 Lezer 解析器 |
| `readOnly` | `boolean` | 让编辑器只读 |
| `darkMode` | `boolean` | 启用黑暗主题 |
| `singleLine` | `boolean` | 将编辑器限制为一行 |
| `lineWrap` | `boolean` | 启用行包 |
| `enableGutters` | `boolean` | 显示行号 |
| `contentAttributes` | `Record<string, string>` | 内容元素的额外属性 |
| `tooltipContainer` | `Element|string` | 工具提示容器 |

## 构建和运行

通过安装所有依赖来准备工程 :

```sh
npm install
```

然后,根据您的使用大小写,您可以运行下列命令:

```sh
# build the library and run all tests
npm run all

# run the development setup
npm run dev

# spin up a simple playground for local development
npm start
```

## 相关

-   [感觉](https://github.com/bpmn-io/feelers) - 感觉单发
-   [@bpmn-io/lezer-feelers (英语)](https://github.com/bpmn-io/feelers/tree/main/packages/lezer-feelers) - 感受者解析定义
-   [@bpmn-io/lang-feelers (英语)](https://github.com/bpmn-io/feelers/tree/main/packages/lang-feelers) - 对CodeMiror 6的感受语言支持
-   [@bpmn-io/ feelers-lint (英语)](https://github.com/bpmn-io/feelers/tree/main/packages/feelers-lint) - 对代码Mirror 6的感应器启动支持
-   [感觉](https://github.com/bpmn-io/feelers/tree/main/packages/feelers) - 感官翻译
-   [长发](https://github.com/nikku/lezer-feel) - Lezer 解析器系统的语言定义

## 许可证

麻省理工学院

## 常见问题

### @bpmn-io/feelers-editor 是什么？

以 CodeMiror 6 为基础的感官编辑器组件\.

### 如何安装 @bpmn-io/feelers-editor？

在项目目录运行 npm install @bpmn-io/feelers-editor，或使用 pnpm add / yarn add / bun add。

### @bpmn-io/feelers-editor 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bpmn-io/feelers-editor 支持 ESM 还是 CommonJS？

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

### @bpmn-io/feelers-editor 可以商用吗？

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

### @bpmn-io/feelers-editor 的下载量有多少？

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

### @bpmn-io/feelers-editor 还在维护吗？

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