# @advanced-rest-client/raw-payload-editor 中文文档

规范地址：https://npmcn.com/package/%40advanced-rest-client/raw-payload-editor/

版本：3\.0\.7
npm 元数据更新时间：2026-04-07T19:30:57.144Z
中文译文更新时间：2026-11-06T12:14:33.752Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：46.9 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：8 个
- 首次发布：2019-02-22T16:03:58.407Z
- 最新版本发布：2021-10-01T10:19:02.418Z
- 近 30 天下载量：3240（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

基于 CodeMirror 的原始有效载荷输入编辑器

## 安装

```sh
npm install @advanced-rest-client/raw-payload-editor
```

也可以使用：`pnpm add @advanced-rest-client/raw-payload-editor`、`yarn add @advanced-rest-client/raw-payload-editor`、`bun add @advanced-rest-client/raw-payload-editor`

## README

# 被否决

这一构成部分已贬值。 代码基础已移动到 [机身编辑器](https://github.com/advanced-rest-client/body-editor) 模块.

* * *

一个带有CodeMiror编辑器的元素,允许用户输入HTTP消息正文.

> 本部分不再开发. 请不要使用它.

## V3 中突破更改

1.  升级

该元素现在使用LitElement库来代替Polymer. 这意味着所有属性都是小写,没有 `-` 字符键. 举例来说,以前 `lineSeparator` 财产反映为 `line-separator` 属性。 现在是 `lineseparator` 属性.

2.  标签处理

CodeMiror 陷阱聚焦于编辑区域. 这不是处理用户输入的可用方式 。 由于此元素会超越默认的标签键行为 并删除元素中的焦点.

3.  所需进口

此版本对网页组件使用最新和最终的光谱. 这意味着组件作为ES模块工作. 因为这样 在向 DOM 插入此元素之前, 文件必须包含 CodeMiror 和相关库 . CodeMirror 6 可能与ES的进口合作,但目前还没有被固定在一块石头上.

以下为要添加到文档中的默认脚本集.

```html
<script src="node_modules/codemirror/lib/codemirror.js"></script>
<script src="node_modules/codemirror/addon/mode/loadmode.js"></script>
<script src="node_modules/codemirror/mode/meta.js"></script>
<!--Default set of parsers -->
<script src="node_modules/codemirror/mode/javascript/javascript.js"></script>
<script src="node_modules/codemirror/mode/xml/xml.js"></script>
<script src="node_modules/codemirror/mode/htmlmixed/htmlmixed.js"></script>
```

如果你使用 JSON linter

```html
<script src="node_modules/jsonlint/lib/jsonlint.js"></script>
<script src="node_modules/codemirror/addon/lint/lint.js"></script>
<script src="node_modules/codemirror/addon/lint/json-lint.js"></script>
<link rel="stylesheet" href="node_modules/codemirror/addon/lint/lint.css" />
```

最后,如果您的应用程序会使用文档中没有包含的模式,您应该设置导入URI. 这将用来解决模式依赖性 .

```html
<script>
CodeMirror.modeURL = 'node_modules/codemirror/mode/%N/%N.js';
</script>
```

### API 组件

此组件是 [API 生态系统组成部分](https://elements.advancedrestclient.com/)

## 使用量

### 安装

```
npm install --save @advanced-rest-client/raw-payload-editor
```

### 在 html 文件内

```html
<html>
  <head>
    <script type="module">
      import '@advanced-rest-client/raw-payload-editor/raw-payload-editor.js';
    </script>
  </head>
  <body>
    <raw-payload-editor contenttype="application/json"></raw-payload-editor>
    <script>
    {
      document.querySelector('raw-payload-editor').onvalue = (e) => {
        console.log(e.target.value);
      }
    }
    </script>
  </body>
</html>
```

### 在一个LitElement中

```js
import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/code-mirror/code-mirror.js';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <code-mirror contenttype="application/json" @value-changed="${this._valueHandler}"></code-mirror>
    `;
  }

  _valueHandler(e) {
    this.value = e.detail.value;
  }
}
customElements.define('sample-element', SampleElement);
```

### 发展

```sh
git clone https://github.com/advanced-rest-client/raw-payload-editor
cd raw-payload-editor
npm install
```

### 本地运行演示

```sh
npm start
```

### 运行测试

```sh
npm test
```

## 常见问题

### @advanced-rest-client/raw-payload-editor 是什么？

基于 CodeMirror 的原始有效载荷输入编辑器

### 如何安装 @advanced-rest-client/raw-payload-editor？

在项目目录运行 npm install @advanced-rest-client/raw-payload-editor，或使用 pnpm add / yarn add / bun add。

### @advanced-rest-client/raw-payload-editor 支持 TypeScript 吗？

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

### @advanced-rest-client/raw-payload-editor 支持 ESM 还是 CommonJS？

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

### @advanced-rest-client/raw-payload-editor 可以商用吗？

@advanced-rest-client/raw-payload-editor 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @advanced-rest-client/raw-payload-editor 的下载量有多少？

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

### @advanced-rest-client/raw-payload-editor 还在维护吗？

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

