# @advanced-rest-client/code-mirror 中文文档

规范地址：https://npmcn.com/package/%40advanced-rest-client/code-mirror/

版本：3\.1\.5
npm 元数据更新时间：2026-04-07T19:24:23.605Z
中文译文更新时间：2026-11-06T11:32:19.910Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：140 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2018-05-18T22:10:36.868Z
- 最新版本发布：2021-03-12T00:20:49.612Z
- 近 30 天下载量：3377（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

CodeMiror 作为网络组件

## 安装

```sh
npm install @advanced-rest-client/code-mirror
```

也可以使用：`pnpm add @advanced-rest-client/code-mirror`、`yarn add @advanced-rest-client/code-mirror`、`bun add @advanced-rest-client/code-mirror`

## README

# 代码镜像网络组件

[![Tests and publishing](https://github.com/advanced-rest-client/code-mirror/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/code-mirror/actions/workflows/deployment.yml)

[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/code-mirror.svg)](https://www.npmjs.com/package/@advanced-rest-client/code-mirror)

这是CodeMirror图书馆的包装纸. 现已调整为在影子DOM内工作. 该组件被高级REST客户端和API Console所使用.

## 所需进口

在向 DOM 插入此元素之前, 文件必须包含 CodeMirror 库 . 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>
```

## 访问选项

该元素暴露 `setOption()` 函数,用于直接设置编辑器选项.

```javascript
cm.setOption('extraKeys', {
 'Ctrl-Space': (cm) => {
   CodeMirror.showHint(cm, CodeMirror.hint['http-headers'], {
     container: containerRef
   });
 }
});
```

此外,该要素有: `editor` 指代代码Merror实例的属性.

## 渲染隐藏元素

如果该元素是活动但无法显示, 您可能需要调用 `refresh()` 函数在 CodeMiror 实例上 显示元素后.

```javascript
parent.style.display = 'block';
cm.editor.refresh();
```

## 样式

见 `codemirror-styles.js` cSS 变量定义的文件.

## 使用量

### 安装

```sh
npm install --save @advanced-rest-client/code-mirror
```

### 在 html 文件内

```html
<html>
  <head>
    <script type="module">
      import '@advanced-rest-client/code-mirror/code-mirror.js';
    </script>
  </head>
  <body>
    <code-mirror mode="javascript">
      function myScript() {
        return 100;
      }
    </code-mirror>
  </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 @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/code-mirror
cd code-mirror
npm install
```

### 本地运行演示

```sh
npm start
```

### 运行测试

```sh
npm test
```

## 常见问题

### @advanced-rest-client/code-mirror 是什么？

CodeMiror 作为网络组件

### 如何安装 @advanced-rest-client/code-mirror？

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

### @advanced-rest-client/code-mirror 支持 TypeScript 吗？

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

### @advanced-rest-client/code-mirror 支持 ESM 还是 CommonJS？

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

### @advanced-rest-client/code-mirror 可以商用吗？

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

### @advanced-rest-client/code-mirror 的下载量有多少？

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

### @advanced-rest-client/code-mirror 还在维护吗？

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