@advanced-rest-client/raw-payload-editor

中文文档
3.0.7发布于 2021/10/01Apache-2.0ESM + CJS近 30 天下载 3240

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

中文使用文档
文档目录9 节
  1. V3 中突破更改
  2. API 组件
  3. 使用量
  4. 安装
  5. 在 html 文件内
  6. 在一个LitElement中
  7. 发展
  8. 本地运行演示
  9. 运行测试

被否决

这一构成部分已贬值。 代码基础已移动到 机身编辑器 模块.


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

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

V3 中突破更改

  1. 升级

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

  1. 标签处理

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

  1. 所需进口

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

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

<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

<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. 这将用来解决模式依赖性 .

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

API 组件

此组件是 API 生态系统组成部分

使用量

安装

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

在 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中

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);

发展

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

本地运行演示

npm start

运行测试

npm test

版本与发布记录

@advanced-rest-client/raw-payload-editor 共发布 11 个版本,首次发布于 2019/02/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.7latest2021/10/015 年前
3.0.62019/11/216 年前
3.0.52019/10/177 年前
3.0.42019/08/247 年前
3.0.32019/08/207 年前
3.0.22019/08/207 年前

关于 @advanced-rest-client/raw-payload-editor 的常见问题

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