# @formdown/editor 中文文档

规范地址：https://npmcn.com/package/%40formdown/editor/

版本：0\.26\.1
npm 元数据更新时间：2026-11-09T07:21:09.296Z
中文译文更新时间：2026-11-15T08:48:05.915Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40formdown/editor
原文对照：https://npmcn.com/package/%40formdown/editor/?lang=original
项目主页：https://formdown.dev/
源码仓库：https://github.com/iyulab/formdown

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

- 包体积（解压后）：2.2 MB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-06-23T02:09:25.186Z
- 最新版本发布：2026-11-09T07:21:08.886Z
- 近 30 天下载量：2202（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 39 个）

## 中文简介

具有高级编辑功能的Formdown语法开发工具

## 安装

```sh
npm install @formdown/editor
```

也可以使用：`pnpm add @formdown/editor`、`yarn add @formdown/editor`、`bun add @formdown/editor`

## README

# @ formdown/编辑器

Formdown 的 Web 组件编辑器: 文本区域中的源, 其旁边的窗体.

## 安装

```bash
npm install @formdown/editor
```

导入软件包登记册 `<formdown-editor>` 编辑 `<formdown-ui>` 它的预览画.

## 使用量

### HTML 语言

```html
<script type="module">
  import '@formdown/editor'
</script>

<formdown-editor mode="split" content="@name: [text required]"></formdown-editor>
```

### Java 脚本

```typescript
import { createFormdownEditor } from '@formdown/editor'

const editor = createFormdownEditor(document.getElementById('editor'), {
  content: '@name: [text required]',
  mode: 'split',
})

editor.addEventListener('contentChange', (event) => {
  console.log('New source:', event.detail.content)
})
```

## 属性

-   `content` (字符串)——"Formdown"来源. 当 `content` 未设置.
-   `mode` (单位:千美元)`'edit' | 'split' | 'view'`默认值 `'split'`)——出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出自出.
-   `placeholder` (字符串)——以空出处显示.
-   `header` (布尔,默认) `false`——每面板上划一行.
-   `toolbar` (布尔,默认) `true`)——插入每种常见类型的字段的按钮.
-   `data` (object)——表单字段的值.

## 方法

-   `validate()` ——预览表的验证结果.
-   `getFormData()` ——预览表的值.

## 活动

-   `contentChange` - 来源改变; `detail.content` 是新来源.
-   `formdown-data-update` 形式改变的价值; `detail.formData` 把他们全部抓起来.
-   `formdown-change` - 一个领域发生了变化,因为 `<formdown-ui>` 报告: `detail.fieldName`, (中文(简体) ), `detail.value`, (中文(简体) ), `detail.formData`。 。 。 .

## 写入源

在您输入时, 您刚刚开始的字段已经完成, 而一个撤销将结束 :

-   线上其他文本后的三个下划线 `@` 用于字段名称(`Name: ___` → `Name: ___@`(三);
-   后面的空格 `@name:` 在一个行的开头得到 `[]`里面有球场类型的护身符.

标签插入两个空格.

## 文档

完整文件请访问 [格式化文档](https://github.com/iyulab/formdown)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @formdown/editor 是什么？

具有高级编辑功能的Formdown语法开发工具

### 如何安装 @formdown/editor？

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

### @formdown/editor 支持 TypeScript 吗？

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

### @formdown/editor 支持 ESM 还是 CommonJS？

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

### @formdown/editor 可以商用吗？

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

### @formdown/editor 的下载量有多少？

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

### @formdown/editor 还在维护吗？

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